-
Notifications
You must be signed in to change notification settings - Fork 118
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
Updating NEURON instruction installation on windows #2998
base: master
Are you sure you want to change the base?
Conversation
✔️ 4c1f128 -> Azure artifacts URL |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2998 +/- ##
=======================================
Coverage 67.28% 67.28%
=======================================
Files 572 572
Lines 104967 104961 -6
=======================================
+ Hits 70622 70627 +5
+ Misses 34345 34334 -11 ☔ View full report in Codecov by Sentry. |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice! thank you @ceciliaromaro!
I just have added a few nitpicks / minor comments.
Once the installer is downloaded, you can install it by double clicking like any other Windows application. | ||
Follow the installation box steps. | ||
|
||
PS: The `pip install neuron` will not work properly in Windows. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ceciliaromaro : just to clarify - there is no wheel available for Windows, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is correct. There is no wheel available for Windows.
A PATH problem that I'm not sure how to reproduce all error possibilities. But it seems to be correlated with the python installation process (from Windows Microsoft Store (as an app) or by Python Webpage and/or Conda) and/or neuron/python order (I've stalled neuron before python and didn’t get this problem) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a nitpick: As this is inside README, I think it better to write this differently:
There can be PATH-related issues that may result in errors during the runtime.
These issues often stem from how Python is installed, whether it's through the Windows
Microsoft Store, the Python website, or via Conda. Additionally, the order of installation
(Neuron before Python, for example) can also affect the setup.
By the way, stalled
-> installed
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I disagree with a default recommendation of using Conda to provide Python, this should be optional, and there should be a first instruction to use the official Python installer or the modern Windows built-in winget
.
#### Step 2: Install conda by [miniconda](https://docs.anaconda.com/free/miniconda/) | ||
Follow the installation box steps. Select "Add Miniconda3 to my PATH environment variable" option, otherwise you will need do it manually after. | ||
This picture: | ||
|
||
![miniconda installation dialog box showing checked box](images/Install_conda_by_miniconda_1.png) | ||
|
||
Or this one: | ||
|
||
![zoomed in view of the checked box in miniconda installation](images/Install_conda_by_miniconda_2.png) | ||
|
||
#### Step 3: Open a Windows PowerShell terminal (or CDM) | ||
|
||
---------------------- | ||
|
||
#### Step 4: Install Python via conda | ||
|
||
`conda install python=3.#` | ||
where # (the last compatible version) | ||
|
||
```bash | ||
conda install python=3.11 | ||
``` | ||
We recommend installing Python via conda and not via Microsoft Store to avoid manually changing the PATH file. | ||
|
||
---------------------- | ||
|
||
#### Step 5: check python version | ||
|
||
```bash | ||
python --version | ||
``` | ||
If the version is not compatible with neuron do: | ||
|
||
`conda install python=X.XX` ( See Step 4) | ||
|
||
(X.XX the last python version compatible with neuron. Yes, it may be a downgrade) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could be greatly simplified with
winget install Python.Python.3.11
and the user will get an official Python, not the Conda interpretation. The winget
command should be available on modern Windows, and would avoid having to install and buy into the Conda ecosystem as a default recommendation.
conda install panda | ||
``` | ||
|
||
PS: `pip install matplotlib` may also works |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why one or the other? This should not be left ambiguous.
Co-authored-by: Matthias Wolf <[email protected]>
Quality Gate passedIssues Measures |
✔️ 1185b18 -> Azure artifacts URL |
No description provided.