Skip to content

INCF/nineml-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NineML

Documentation Status

Network Interchange for NEuroscience (NineML) is a simulator-independent language with the aim of providing an unambiguous description of neuronal network models for efficient model sharing and reusability (http://nineml.net).

NineML emerged from a joint effort of experts in the fields of computational neuroscience, simulator development and simulator-independent language initiatives (NeuroML, PyNN), grouped in the INCF Multiscale Modeling Task Force: https://www.incf.org/activities/our-programs/modeling/people__. This effort was initiated and is still supported by the Multiscale Modeling Program: https://www.incf.org/activities/our-programs/modeling__, as part of the standardization effort of the International Neuroinformatics Coordinating Facility (INCF), but the project is now run as a community project.

How to build the source

The source is written in reStructured text and can be build using Sphinx (http://www.sphinx-doc.org/) using the provided Makefile (or the make.bat if on Windows). If you have pip setup you can install sphinx, along with the Read-the-docs theme, with:

$ pip install sphinx sphinx-rtd-theme

HTML

To make the html docs use the command

$ make html

PDF

To make the pdf you will also need a TeX distribution installed (see MacTex on macOS or the texlive-full package on Ubuntu/Debian). After that the PDF can be made with.

$ make latexpdf

In addition to this main NineML repository, which only contains the specification document and XML schema, there are related repositories that are maintained by the NineML team (see http://nineml.net/committee).

  • NineML Python Library: A Python library for reading, writing and manipulating NineML descriptions
  • NineMLCatalog: A collection of example NineML models serialized to XML.