Skip to content

Commit

Permalink
feat(examples): note how to set NEURON_HOME
Browse files Browse the repository at this point in the history
  • Loading branch information
sanjayankur31 committed Mar 1, 2024
1 parent 2875fa9 commit 5a446a8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
5 changes: 4 additions & 1 deletion source/Userdocs/IzhikevichNetworkExample.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ We will create a small network of cells, simulate this network, and generate a p
Spike times of neurons in 2 populations recorded from the simulation.
```

The Python script used to create the model, simulate it, and generate this plot is below:
The Python script used to create the model, simulate it, and generate this plot is below.
Please note that this example uses the {ref}`NEURON <userdocs:neuron>` simulator to simulate the model.
Please ensure that the `NEURON_HOME` environment variable is correctly set as noted {ref}`here <userdocs:neuron:envvar>`.

```{literalinclude} ./NML2_examples/izhikevich-network.py
----
language: python
Expand Down
3 changes: 3 additions & 0 deletions source/Userdocs/MultiCompartmentOLMexample.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,9 @@ Level 10 network graph generated by pynml
```
## Simulating the model

Please note that this example uses the {ref}`NEURON <userdocs:neuron>` simulator to simulate the model.
Please ensure that the `NEURON_HOME` environment variable is correctly set as noted {ref}`here <userdocs:neuron:envvar>`.

Now that we have declared and inspected our network model and all its components, we can proceed to simulate it.
We do this in the `main` function:
```{literalinclude} ./NML2_examples/olm-example.py
Expand Down

0 comments on commit 5a446a8

Please sign in to comment.