Skip to content

Document cmake option: NRN_INSTALL_PYTHON_PREFIX#3747

Open
ctrl-z-9000-times wants to merge 3 commits intoneuronsimulator:masterfrom
ctrl-z-9000-times:python-install-prefix
Open

Document cmake option: NRN_INSTALL_PYTHON_PREFIX#3747
ctrl-z-9000-times wants to merge 3 commits intoneuronsimulator:masterfrom
ctrl-z-9000-times:python-install-prefix

Conversation

@ctrl-z-9000-times
Copy link
Copy Markdown
Contributor

Fixes issue #3746

@codacy-production
Copy link
Copy Markdown

codacy-production bot commented Apr 19, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.32%. Comparing base (07bb663) to head (3aba765).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3747      +/-   ##
==========================================
- Coverage   68.33%   68.32%   -0.01%     
==========================================
  Files         691      691              
  Lines      111113   111113              
==========================================
- Hits        75930    75920      -10     
- Misses      35183    35193      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.


NRN_INSTALL_PYTHON_PREFIX:STRING="lib/python/neuron/"
-----------------------------------------------------
Path where NEURON Python components will be installed
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Unless building a wheel (then the value will be forced to "neuron/")


.. code-block:: shell

python -m site --user-site
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

It might be worth adding a note that the above doesn't resolve virtual environments, so one should install packages to this path with caution - I hope that many people use virtual environments now (through uv) to keep their dependencies separate, so using this facility might have surprising effects.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

venv installs it's packages to "venv_root/lib/python3.10/site-packages/" but I don't know how the user can find this automatically.

Instead I changed the documentation to say:
"Note: Non-standard installations (such as python virtual environments) have non-standard install paths."

@sonarqubecloud
Copy link
Copy Markdown

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.

3 participants