Skip to content

Commit c8289d4

Browse files
authored
Make neuron the default package name (#3807)
* Previously, `neuron-nightly` was the default package name when installing via a method that read `pyproject.toml`. * When released, the `packaging/python/change_name.py` was used to change. * Flip this; by default `pyproject.toml` has `neuron`, and when nightly wheels are updated, the `change_name.py` is used to set the name to `neuron-nightly`
1 parent dc3ebb2 commit c8289d4

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

.github/workflows/wheels-template.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,12 @@ jobs:
114114
sudo bash packaging/python/build_static_readline_osx.bash
115115
116116
- name: Change name of package for release
117-
if: inputs.build_type == 'release'
117+
if: inputs.build_type == 'nightly'
118118
run: |
119119
python3 -m venv venv
120120
source venv/bin/activate
121121
python3 -m pip install tomli tomli-w
122-
python3 packaging/python/change_name.py ./pyproject.toml neuron
122+
python3 packaging/python/change_name.py ./pyproject.toml neuron-nightly
123123
124124
- name: Optimize RX3D Python module
125125
if: inputs.optimize_rxd == true

docs/install/python_wheels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Any official update of these files shall imply a PR reviewed and merged before `
2727

2828
All wheels built on Azure are:
2929

30-
* Published to `Pypi.org` as
30+
* Published to `pypi.org` as
3131
* `neuron-nightly` -> when the pipeline is launched in CRON mode
3232
* `neuron-x.y.z` -> when the pipeline is manually triggered for release `x.y.z`
3333
* Stored as `Azure artifacts` in the Azure pipeline for every run.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ requires = [
2424
# when making a release since PEP 621 disallows dynamic names.
2525
# Note that this only affects the name of the _wheel_, not the importable package name,
2626
# nor the CMake project name.
27-
name = "neuron-nightly"
27+
name = "neuron"
2828
description = "Empirically-based simulator for modeling neurons and networks of neurons"
2929
readme = { file = "README.md", content-type = "text/markdown" }
3030
license = { file = "Copyright" }

0 commit comments

Comments
 (0)