Merge remote-tracking branch 'refs/remotes/lettucecfd/update-readme' into 226-feature-add-simple-first_examplypy

Author: PhiSpel

README.rst

@@ -40,65 +40,57 @@ Resources
 .. _Video: https://www.youtube.com/watch?v=7nVCuuZDCYA
 .. _Code: https://github.com/lettucecfd/lettuce-paper
 
-
-Resources
----------
-
-- `Documentation`_
-- Presentation at CFDML2021 - `Preprint`_ | `Slides`_ | `Video`_ | `Code`_
-
-.. _Documentation: https://lettuceboltzmann.readthedocs.io
-.. _Preprint: https://arxiv.org/pdf/2106.12929.pdf
-.. _Slides: https://drive.google.com/file/d/1jyJFKgmRBTXhPvTfrwFs292S4MC3Fqh8/view
-.. _Video: https://www.youtube.com/watch?v=7nVCuuZDCYA
-.. _Code: https://github.com/lettucecfd/lettuce-paper
-
 Getting Started
 ---------------
 
-The following Python code will run a two-dimensional Taylor-Green vortex on a GPU:
+To find some very simple examples of how to use lettuce, please have a look
+at the examples_. These will guide you through lettuce's main features.
 
-.. code:: python
+Please ensure you have Jupyter installed to run the Jupyter notebooks.
 
-    import torch
-    import lettuce as lt
+.. _examples: https://github.com/lettucecfd/lettuce/tree/master/examples
 
-    lattice = lt.Lattice(lt.D2Q9, device='cuda', dtype=torch.float64, use_native=False)  # for running on cpu: device='cpu'
-    flow = lt.TaylorGreenVortex2D(resolution=128, reynolds_number=100, mach_number=0.05, lattice=lattice)
-    collision = lt.BGKCollision(lattice, tau=flow.units.relaxation_parameter_lu)
-    streaming = lt.StandardStreaming(lattice)
-    simulation = lt.Simulation(flow=flow, lattice=lattice, collision=collision, streaming=streaming)
-    mlups = simulation.step(num_steps=1000)
-    print("Performance in MLUPS:", mlups)
+Installation
+------------
 
-More advanced examples_ are available as jupyter notebooks.
+* Install the anaconda or miniconda package manager from www.anaconda.org
+* Create a new conda environment and activate it::
 
-Please ensure you have Jupyter installed to run these notebooks.
+    conda create -n lettuce
+    conda activate lettuce
 
-.. _examples: https://github.com/lettucecfd/lettuce/tree/master/examples
+* Follow the recommendations at https://pytorch.org/get-started/locally/ to
+install pytorch based on your GPU's CUDA version. You may need to install
+the nvidia toolkit. You may follow the instructions at https://developer
+.nvidia.com/cuda-downloads. You may need to check the compatibility of your
+NVIDIA driver with the desired CUDA version:
+https://docs.nvidia.com/deploy/cuda-compatibility/. To get your CUDA version,
+run::
 
-Installation
-------------
+    nvcc --version
 
-* Install the anaconda package manager from www.anaconda.org
-* Create a new conda environment and install PyTorch::
+* For CUDA 12.1 (if supported by your GPU) use::
 
-    conda create -n lettuce -c pytorch -c nvidia pytorch pytorch-cuda=12.1
+    conda install pytorch pytorch-cuda=12.1 -c pytorch -c nvidia
 
-* Activate the conda environment::
+* Install the remaining dependencies::
 
     conda activate lettuce
+    conda install -c pytorch -c conda-forge matplotlib pytest click pyevtk mmh3 h5py scipy pandas numpy
 
-* Install all requirements::
+* Clone this repository from github and change to it::
 
-    conda install -c conda-forge -c anaconda matplotlib pytest click pyevtk h5py mmh3
+    git clone https://github.com/lettucecfd/lettuce
+    cd lettuce
 
-* Clone this repository from github
-* Change into the cloned directory
-* Run the install script::
+* If you want to only **USE** lettuce, run the install script::
 
     python setup.py install
 
+* If you are a **developer**, do this to update the lettuce package when running a script::
+
+    python setup.py develop
+
 * Run the test cases::
 
     python setup.py test
@@ -107,15 +99,14 @@ Installation
 
     lettuce --no-cuda convergence
 
-* For running a CUDA-driven LBM simulation on one GPU omit the `--no-cuda`. If CUDA is not found,
-  make sure that cuda drivers are installed and compatible with the installed cudatoolkit
-  (see conda install command above).
+* For running a CUDA-driven LBM simulation on one GPU omit the `--no-cuda`.
+If CUDA is not found, make sure that cuda drivers are installed and
+compatible with the installed cudatoolkit (see conda install command above).
 
 * Check out the performance, running on GPU::
 
     lettuce benchmark
 
-
 Citation
 --------
 If you use Lettuce in your research, please cite the following paper::
@@ -128,7 +119,6 @@ If you use Lettuce in your research, please cite the following paper::
       organization={Springer Nature}
     }
 
-
 Credits
 -------
 We use the following third-party packages:

setup.py

@@ -12,7 +12,7 @@
 with open('HISTORY.rst') as history_file:
     history = history_file.read()
 
-requirements = ['Click>=6.0', "torch>=2.1", "numpy==1.26.4", "matplotlib==3.9.0", "pyevtk", "h5py>=3.2.1", "mmh3"]
+requirements = ['Click>=6.0', "torch>=2.1", "numpy==1.26.4", "matplotlib", "pyevtk", "h5py>=3.2.1", "mmh3"]
 
 setup_requirements = ['pytest-runner', 'pytest']