|
 |
8f72bec |
# nest
|
|
|
8f72bec |
|
|
 |
0a0f095 |
The neural simulation tool.
|
|
|
0a0f095 |
|
|
|
0a0f095 |
Note: it is not yet built with `libneurosim` support, so all models may not be
|
|
|
0a0f095 |
available in `PyNN`.
|
|
|
0a0f095 |
|
|
|
0a0f095 |
This documentation is also provided with each nest package variant as
|
|
|
0a0f095 |
`README.Fedora` (`nest`, `nest-mpich`, `nest-openmpi`):
|
|
|
0a0f095 |
|
|
|
0a0f095 |
The Fedora packages of the NEST simulator are built to cover various
|
|
|
0a0f095 |
configurations and installs their files in the standard locations:
|
|
|
0a0f095 |
|
|
|
0a0f095 |
- `nest:` NEST simulator without MPI support
|
|
|
0a0f095 |
- `python3-nest:` PyNEST for Python 3 without MPI support
|
|
|
0a0f095 |
|
|
|
0a0f095 |
- `nest-mpich:` NEST simulator build with MPICH support
|
|
|
0a0f095 |
- `python3-nest-mpich:` PyNEST for Python 3 with MPICH support
|
|
|
0a0f095 |
|
|
|
0a0f095 |
- `nest-openmpi:` NEST simulator build with OpenMPI support
|
|
|
0a0f095 |
- `python3-nest-openmpi:` PyNEST for Python 3 with OpenMPI support
|
|
|
0a0f095 |
|
|
|
0a0f095 |
Usage
|
|
|
0a0f095 |
-----
|
|
|
0a0f095 |
|
|
|
0a0f095 |
The `nest_vars.sh` must be sourced to set up the environment correctly for NEST,
|
|
|
0a0f095 |
which makes use of a few environment variables:
|
|
|
0a0f095 |
|
|
|
0a0f095 |
- `NEST_INSTALL_DIR`
|
|
|
0a0f095 |
- `NEST_DATA_DIR`
|
|
|
0a0f095 |
- `NEST_MODULE_PATH`
|
|
|
0a0f095 |
- `NEST_PYTHON_PREFIX`
|
|
|
0a0f095 |
- `NEST_DOC_DIR`
|
|
|
0a0f095 |
|
|
|
0a0f095 |
The `nest_vars.sh` file is located in:
|
|
|
0a0f095 |
|
|
|
0a0f095 |
For MPICH builds:
|
|
|
0a0f095 |
|
|
|
b6af78e |
`source /usr/lib64/mpich/bin/nest_vars_mpich.sh`
|
|
|
0a0f095 |
|
|
|
0a0f095 |
For OpenMPI builds:
|
|
|
b6af78e |
`source /usr/lib64/openmpi/bin/nest_vars_openmpi.sh`
|
|
|
0a0f095 |
|
|
|
0a0f095 |
|
|
|
0a0f095 |
For non MPI builds:
|
|
|
0a0f095 |
`source /usr/bin/nest_vars.sh`
|
|
|
0a0f095 |
|
|
|
0a0f095 |
To use an MPI build of NEST, one must also load the appropriate module.
|
|
|
0a0f095 |
For MPICH builds:
|
|
|
0a0f095 |
|
|
|
6c61f2c |
`module load mpi/mpich-$arch # $arch is the architecture, for example x86_64`
|
|
|
0a0f095 |
|
|
|
0a0f095 |
For OpenMPI builds:
|
|
|
0a0f095 |
|
|
|
6c61f2c |
`module load mpi/openmpi-$arch # $arch is the architecture, for example x86_64`
|
|
|
0a0f095 |
|
|
|
0a0f095 |
It is generally easier to add these lines to the `~/.bashrc` file (for bash
|
|
|
0a0f095 |
users) so that these commands are automatically run on each login.
|
|
|
0a0f095 |
|
|
|
b6af78e |
The binaries for each MPI build are suffixed to distinguish them from each
|
|
|
b6af78e |
other:
|
|
|
b6af78e |
|
|
|
b6af78e |
For MPICH builds, they would be:
|
|
|
b6af78e |
|
|
|
b6af78e |
``````
|
|
|
b6af78e |
nest_mpich
|
|
|
b6af78e |
nest_vars_mpich.sh
|
|
|
b6af78e |
nest_config_mpich
|
|
|
b6af78e |
nest_serial_mpich
|
|
|
b6af78e |
nest_indirect_mpich
|
|
|
b6af78e |
sli_mpich
|
|
|
b6af78e |
``````
|
|
|
b6af78e |
|
|
|
b6af78e |
For OpenMPI builds:
|
|
|
b6af78e |
``````
|
|
|
b6af78e |
nest_openmpi
|
|
|
b6af78e |
nest_vars_openmpi.sh
|
|
|
b6af78e |
nest_config_openmpi
|
|
|
b6af78e |
nest_serial_openmpi
|
|
|
b6af78e |
nest_indirect_openmpi
|
|
|
b6af78e |
sli_openmpi
|
|
|
b6af78e |
``````
|
|
|
0a0f095 |
|
|
|
0a0f095 |
Documentation
|
|
|
0a0f095 |
-------------
|
|
|
0a0f095 |
The generated documentation is provided in the nest-doc package, and is common
|
|
|
0a0f095 |
for all builds.
|
|
|
1a7e0de |
|
|
|
1a7e0de |
Official documentation can be found at http://nest-simulator.org/
|
|
|
1a7e0de |
|
|
|
1a7e0de |
For issues with this package, please contact the [NeuroFedora SIG](https://fedoraproject.org/wiki/SIGs/NeuroFedora#Communication_and_getting_help).
|