Skip to content

Commit

Permalink
Merge pull request openworm#53 from austinklein/master
Browse files Browse the repository at this point in the history
Update dependencies, installation, and README
  • Loading branch information
pgleeson authored Dec 6, 2023
2 parents 8adf2e8 + 22e0533 commit 3cbbd16
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,17 @@ The full set of dependencies for c302 can be installed with the following (see a
pip install .
owm bundle remote --user add ow 'https://raw.githubusercontent.com/openworm/owmeta-bundles/master/index.json'

This will install c302 as well as all dependencies, including [pyNeuroML](https://github.com/NeuroML/pyNeuroML) and [owmeta](https://github.com/openworm/owmeta).
This will install c302 as well as [pyNeuroML](https://github.com/NeuroML/pyNeuroML) and [owmeta](https://github.com/openworm/owmeta).

To run the test.sh script, the Neuron simulator is also required, and should be installed as described [here](https://www.neuron.yale.edu/neuron/download).

For Linux users, additional dependencies (OpenJDK 19 and Graphviz) are required to run the Usage Examples:

sudo apt-get install openjdk-19-jdk graphviz

Please note that Python3 is also required to run both the test.sh script and the Usage Examples. For convenience on Linux, it is recommended to install python-is-python3 prior to running the test.sh script.

sudo apt-get install python-is-python3

#### Quick test

Expand All @@ -42,7 +51,7 @@ To ensure everything is set up correctly try:

To test all of the working features of the framework run [test.sh](https://raw.githubusercontent.com/openworm/CElegansNeuroML/master/CElegans/pythonScripts/c302/test.sh):

./test.sh # or ./test3.sh if you use Python 3
./test.sh

### Docker image

Expand Down Expand Up @@ -110,7 +119,7 @@ The other shows membrane potential for each neuron in the network.
![membrane potential](images/LEMS_MyNetwork-membranePotential.png)


To see the structure of the network, use pyNeuroML:
To see the structure of the network, use pyNeuroML (please note that Graphviz is required):

pynml MyNetwork.net.nml -graph 4c # Try other options like 1, 2f, 5c for varying levels of detail

Expand Down
4 changes: 0 additions & 4 deletions test.sh
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
set -ex

## Install

python setup.py install

## Test readers

python -m c302.SpreadsheetDataReader
Expand Down

0 comments on commit 3cbbd16

Please sign in to comment.