Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change readme install instructions #243

Merged
merged 69 commits into from
Aug 28, 2024

Conversation

PhiSpel
Copy link
Contributor

@PhiSpel PhiSpel commented Aug 23, 2024

Description

  • updated requirements to be used directly in PyCharm or conda
  • updated Readme
  • Note: approximate package requirements (~=) are not recognized by Conda
  • Note for Readme: one may need to manually specify the CUDA_HOME variable for native (to the package folder .../cudatoolkit_* containing /bin/nvcc)

closes #170
closes #234

Checklist

  • This pull request is associated to an issue
  • This PR contains a description
  • Add someone else as reviewer and wait for approval before merging.

@PhiSpel PhiSpel linked an issue Aug 23, 2024 that may be closed by this pull request
@PhiSpel PhiSpel self-assigned this Aug 23, 2024
@PhiSpel
Copy link
Contributor Author

PhiSpel commented Aug 23, 2024

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
Copy link
Contributor Author

PhiSpel commented Aug 26, 2024

@McBs

  • do we need exact restricitons for packaging, click and setuptools?
  • can you check if the instructions above or, ideally, in the new readme work for you?

PhiSpel and others added 19 commits August 26, 2024 12:42
…d note in readme

removed cudatoolkit from requirements.txt and added note in readme

added fixation to all required packages

sortet requirements by name

removed version restrictions from setup.py
use conda for installation
remove `with`s in setup-miniconda
…stall-instructions' into 234-feature-change-readme-install-instructions
changed 'torch' to 'pytorch' and upgraded test to python 3.12
add pytorch-cuda to test for ubuntu and windows
…stall-instructions' into 234-feature-change-readme-install-instructions
auto update conda and setup with correct python version
do not auto-activate base
display conda infos
@PhiSpel PhiSpel changed the title 234 feature change readme install instructions feature change readme install instructions Aug 26, 2024
run all tests on same bash
@PhiSpel PhiSpel marked this pull request as ready for review August 26, 2024 13:50
@PhiSpel PhiSpel requested a review from McBs August 26, 2024 13:50
PhiSpel and others added 4 commits August 26, 2024 15:59
compare with non-changable installation
ignoring pep8 for correct line breaks
added pep518 standard for pip setup.py
@McBs
Copy link
Contributor

McBs commented Aug 28, 2024

@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 :-)

Copy link
Contributor

@McBs McBs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@PhiSpel PhiSpel changed the title feature change readme install instructions change readme install instructions Aug 28, 2024
@PhiSpel PhiSpel merged commit 0f9a194 into master Aug 28, 2024
7 checks passed
@PhiSpel PhiSpel deleted the 234-feature-change-readme-install-instructions branch August 28, 2024 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: change readme install instructions Update Requirements and CI for Compatibility with Torch 2.4
2 participants