Skip to content

Commit

Permalink
update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
WillemWybo committed Jan 15, 2025
1 parent 2f2f2b1 commit 52537c2
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 18 deletions.
39 changes: 22 additions & 17 deletions INSTALL.rst
Original file line number Diff line number Diff line change
@@ -1,36 +1,41 @@
Installation
============

Install
-------
**Install**

Note: The following instructions are for Linux and Max OSX systems and only use
command line tools. Please follow the appropriate manuals for Windows systems or
tools with graphical interfaces.
tools with graphical interfaces. The most recent version, NEAT 1.0-rc1 can be
installed from the master branch.

You can install the latest release via pip:
.. code-block:: shell
git clone git@github.com:unibe-cns/NEAT.git
cd NEAT
pip install .
**Post-Install**

.. code-block:: shell
Note that if you install NEAT with pip, as above, NEURON will automatically be installed as well.
To use NEAT with `NEST <https://nest-simulator.readthedocs.io/en/stable/index.html>`_,
you need to manually install NEST on your system, by following the detailed
`installation instructions <https://nest-simulator.readthedocs.io/en/stable/installation/index.html>`_.

pip install neatdend
**Testing the installation**

The adventurous can install the most recent development version directly from our master branch (don't use this in production unless there are good reasons!):
NEAT makes the shell command `neatmodels` available. This command compiles groups of NEAT-defined
ion channels into for NEURON or NEST models, so that they can be simulated.
You can test whether this command is available by installing a set of default ion channels of NEAT:

.. code-block:: shell
git clone git@github.com:unibe-cns/NEAT.git
cd NEAT
pip install .
neatmodels install default
Post-Install
------------
This installs the default channels for NEURON. To install them for NEST, use:

To use NEAT with `NEURON <https://neuron.yale.edu/neuron/>`_, make sure NEURON
is properly installed with its Python interface, and compile and install the
default NEURON mechanisms by running
::
.. code-block:: shell
compilechannels default
neatmodels install default -s nest
To test the installation (requires `pytest`)
::
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ build-backend = "setuptools.build_meta"

[project]
name = 'nest-neat'
version = '1.0-rc1'
version = '1.0-rc2'
authors = [
{name = 'Willem Wybo'},
{name = 'Jakob Jordan'},
Expand Down

0 comments on commit 52537c2

Please sign in to comment.