Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Plotnikov authored Jul 1, 2016
1 parent 471091a commit b269dfc
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,35 @@ an exact solution if possible or use an appropriate numeric solver otherwise.

## Directory structure

`docker` - A docker container with the complete NESTML software pipeline installed
`docker` - A docker containers with the complete NESTML software pipeline installed. Once based on the latest release of NESTML. One that builds the latest development version of NESTML.

`models` - Example neuron models in NESTML format

`src` - The source code of NESTML

## Docker
The docker files can be find in the `docker` folder.

For the usage:
Docker must be installed on the machine. See the follwing resource for the installation instructions https://docs.docker.com/engine/installation

The Dockerfile, e.g. DockerfileRelease, should be stored in a new folder (e.g. nestml_docker). Then be executing the following command in terminal from this folder the docker container can be built:
```
(precondition: cd nestml_docker)
docker build -t nestml_release -f ./DockerfileRelease .
```
If everything goes well, then command 'docker images' container should list a 'nestml_release' container.

Currently, the container is built in the way, that is automatically processes a volume that is mounted at start up. E.g. a NESTML model (https://github.com/nest/nestml/blob/master/models/iaf_cond_alpha_implicit.nestml) can be placed into a folder called 'testing'. Then, the following command will execute model analysis and codegeneration for NEST target (currently, only the NEST master is supported, for earlier version use releases prio 0.1.0):
docker run -v ~/testing/:/nestml nestml_release

It creates a subfolder 'result' in the 'testing' folder that contains the generated code. Per default, the module for the generated stuff is called 'nestml'. In order to integrate the model into nest, use the following commands (assumption, you switched to the 'testing/result'):
```
cmake -Dwith-nest=${NEST_INSTALL_DIR}/bin/nest-config .
make install
```
Again, if everything goes well, you can use the generated model in NEST and PyNEST Scripts. E.g.
```
nest.Install("nestml")
neuron1=nest.Create ("iaf_cond_alpha_implicit")
```

0 comments on commit b269dfc

Please sign in to comment.