@@ -58,6 +58,66 @@ Or install NEST with one of the following options:
5858 pip install nest-simulator[sonata,server]
5959 pip install nest-simulator[examples,server]
6060
61+ Install latest development version
62+ ----------------------------------
63+
64+ Install from GitHub
65+ ~~~~~~~~~~~~~~~~~~~
66+
67+ **Required dependencies: **
68+
69+ Before installing from GitHub, ensure you have the necessary build dependencies.
70+ On Ubuntu/Debian, install them with:
71+
72+ .. code-block :: bash
73+
74+ sudo apt-get update
75+ sudo apt-get install -y git python3 python3-pip libboost-dev python3-venv
76+
77+ To install the latest development version directly from the NEST GitHub repository:
78+
79+ .. code-block :: bash
80+
81+ pip install git+https://github.com/nest/nest-simulator.git
82+
83+ You can also install with extra packages using the ``#egg= `` syntax:
84+
85+ .. code-block :: bash
86+
87+ # Install with all extras (see pyproject.toml to view what's installed)
88+ pip install " git+https://github.com/nest/nest-simulator.git#egg=nest-simulator[full]"
89+
90+ # Install with specific extras
91+ pip install " git+https://github.com/nest/nest-simulator.git#egg=nest-simulator[sonata,server]"
92+
93+ .. note ::
94+
95+ Installing from GitHub installs the latest development version which may be less stable than the released versions on PyPI.
96+
97+ Install from a local repository
98+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99+
100+ To install from a local copy of the NEST repository:
101+
102+ .. code-block :: bash
103+
104+ # Clone the repository if you haven't already
105+ git clone https://github.com/nest/nest-simulator.git
106+ cd nest-simulator
107+
108+ # Install in editable mode (recommended for development)
109+ pip install -e .
110+
111+ # Install with extras (see pyproject.toml to view what's installed)
112+ pip install -e " .[full]"
113+ pip install -e " .[sonata,server]"
114+
115+
116+ .. note ::
117+
118+ When installing from a local repository, ensure you have all required build dependencies installed.
119+
120+
61121Install other desired packages (e.g., you may also want to use NEST in a Jupyter instance):
62122
63123.. code-block :: bash
0 commit comments