lettucecfd / lettuce

Computational Fluid Dynamics based on PyTorch and the Lattice Boltzmann Method
MIT License
222 stars 39 forks source link

change readme install instructions #243

Closed PhiSpel closed 2 months ago

PhiSpel commented 3 months ago

Description

closes #170 closes #234

Checklist

PhiSpel commented 3 months ago

my best bet for installation:

git clone https://github.com/lettucecfd/lettuce.git lettuce
cd lettuce
conda update conda
conda create -n lettuce
conda activate lettuce
...check CUDA version
conda install pytorch>=2.4 pytorch-cuda=12.1 -c pytorch -c nvidia
conda install --file requirements.txt -c pytorch -c nvidia -c conda-forge
...maybe set CUDA_HOME variable
python setup.py develop
lettuce convergence
pytest tests

for now:

git clone https://github.com/lettucecfd/lettuce.git lettucetest
cd lettucetest
git fetch origin
git checkout 234-feature-change-readme-install-instructions
conda create --yes -n lettucetest
conda activate lettucetest
conda install --yes pytorch>=2.4 pytorch-cuda=12.1 -c pytorch -c nvidia
conda install --yes --file requirements.txt -c pytorch -c nvidia -c conda-forge
pip install -e setup.py
lettuce convergence
pytest tests

to tidy up:

cd ..
rm -r lettucetest
conda deactivate
conda remove -n lettucetest --all --yes
PhiSpel commented 3 months ago

@McBs

McBs commented 2 months ago

@McBs

* [x]  do we need exact restricitons for `packaging`, `click` and `setuptools`?

* [x]  can you check if the instructions above or, ideally, in the new readme work for you?

Hi @PhiSpel the instructions work on my workstation :-)