A single package (command line tool and library) in Java to validate, simulate, translate and analyse NeuroML 2 models
Java Python Shell Batchfile
Latest commit 485e905 Jul 12, 2016 @pgleeson pgleeson committed on GitHub Update README.md
Permalink
Failed to load latest commit information.
.settings
src
.classpath
.gitignore
.project
.travis.yml
LICENSE.lesser
README.md
getNeuroML.py
jnml
jnml.bat
pom.xml

README.md

jNeuroML

There are a number of repositories in active development under GitHub for handling NeuroML and LEMS with Java. To make it easier to access all of this functionality, we've created a single package, jNeuroML, which allows access to most of this functionality through a simple command line interface and requires minimal installation.

jNeuroML can:

  • Validate NeuroML v1.8.1 and v2.x files
  • Simulate most NeuroML 2 models (simulation should be specificed in Simulation element in LEMS file)
  • Export NeuroML 2 and LEMS to many formats such as Neuron, Brian, Matlab, etc.
  • Import other languages into LEMS (e.g. SBML)

Binary installation

To get a precompiled binary for jNeuroML, go to https://github.com/NeuroML/jNeuroML/releases, download the latest jNeuroML.zip file and you have everything you need. Unzip on your local machine and go into the jNeuroMLJar directory.

Usage

Typing ./jnml (or jnml.bat on Windows) will list the options available. Some of the current options include:

./jnml -validate MyNeuroML.nml              (validate NeuroML 2 document against the current schema)
./jnml -validatev1 MyNeuroML1.xml           (validate NeuroML v1 document against the v1.8.1 schema)
./jnml MyLEMS.xml                           (parse & simulate a LEMS model using jLEMS)
./jnml MyLEMS.xml -graph                    (generate png of structure of LEMS model using GraphViz)
./jnml MyLEMS.xml -neuron                   (generate code to run on the NEURON simulator)

Export and import features for NEURON, SBML, Brian etc. are under active development (see https://github.com/NeuroML/org.neuroml.export and https://github.com/NeuroML/org.neuroml.import).

Note:

Adding the environment variable JNML_HOME, pointing to the jNeuroML folder, as well as adding this path to the PATH variable will let you use the jnml utility from any folder.

Getting the source for jNeuroML

If you prefer to clone all of the individual repositories and build the jNeuroML application yourself, use the getNeuroML.py utility in the jNeuroML repo:

git clone git://github.com/NeuroML/jNeuroML.git neuroml_dev/jNeuroML
cd neuroml_dev/jNeuroML
python getNeuroML.py

This will clone ~11 repos for NML2 & LEMS (including Python based libraries) into neuroml_dev/ and compile the Java based ones using Maven (download here or use package managers for Linux (e.g. apt-get install maven) or Mac (brew install maven)). The full process may take 5-10 mins on first installation, but subsequently running:

git pull
python getNeuroML.py

in the jNeuroML folder will get the stable version of each repo & compile using Maven if necessary.

To access the very latest version (the development branches of the GitHub repos) use:

python getNeuroML.py clean
python getNeuroML.py development

Use of Maven is a great way to manage versions of applications being developed in distributed repositories, and will make it easy to use selected parts of this for different Java applications. For example, these packages will be used in various ways to provide NeuroML/LEMS support in neuroConstruct and for handling NeuroML on the Open Source Brain website.

Prefer Python?

If you prefer using/installing/coding in Python, try out pyNeuroML. Much of the functionality of jNeuroML is bundled inside pyNeuroML and can be accessed with a command line utility (pynml) with similar usage as jnml.

Build Status

This code is distributed under the terms of the GNU Lesser General Public License.