Changes to installation instructions #40
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
| @@ -40,8 +41,9 @@ Required dependencies are: | |||
|
|
|||
| To create an environment in Anaconda, execute: | |||
| ```sh | |||
| conda create -n pymecht | |||
| conda create -n pymecht python=3.X | |||
There was a problem hiding this comment.
I think we can suggest a Python version (3.9 is what I have been using for the most part). And then mention in the comments below that users can choose another version out of ....
|
Another suggestion: should we have only the "user" installation instructions in README.md and keep the "develop" installation instructions in "CONTRIBUTING.md"? We also have installation instructions in the readthedoc documentation. Maybe I will update it to match that in README.md |
|
The final decision about whether to only have the user install instructions in the README.md is up to you. I can do that but I am fine with both methods appearing on the front of the repo. CONTRIBUTING.md then covers other aspects such as PRs etc. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Now I have further investigated the issue, PyTorch is not supported on Python3.13. This was the issue that the reviewers were encountering, I reckon.
All tests pass for >=3.8 and <3.13. As such, I have changed the supported versions to also be in this range. I have updated the shield to be automatically pulled from the pyproject.toml file and there is now installation instructions with the Python version included. I am less inclined to state a specific version as I have no reason for the user to use 3.8 over 3.12, for example.