Skip to main content

A collection of 9ML models and basic Python functions for accessing them

Project description

https://travis-ci.org/INCF/nineml-catalog.svg https://coveralls.io/repos/github/INCF/nineml-catalog/badge.svg Supported Python versions Latest Version

The NineML Catalog is a collection of NineML models written in XML. See http://nineml.net/software/ for a list of software that support NineML.

Also included is a simple Python module ‘ninemlcatalog’ for convenient access to the models stored in the catalog using the NineML Python library.

Editors

The NineML Catalog is maintained by the NineML committee (http://nineml.net/committee).

Installation

To “install” the XML models in the NineML Catalog simply clone the repository to somewhere sensible on your local computer (e.g. $HOME/git/nineml-catalog), and then you can reference the models from other NineML documents using either relative or absolute URLs. Before cloning, it is best to create a fork of the central repo (https://github.com/INCF/nineml-catalog) so you can backup any modifications to your own GitHub repo, and then open merge requests with the central repo (see Contributing).

To install the python module you will need to install the NineML Python library. Then simply add the ‘python’ directory in the catalog repository to your PYTHONPATH. Once NineML Python library is installed you will then be able to run the unit-tests by the command

$ python -m unittest test

from the git repository directory and it will attempt to load and validate every model in the catalog.

Contributing

Contributions to the catalog are most welcome. To add a model or amend an existing one simply make the changes to your local model, push them to your GitHub fork and open a pull request to the master branch of the INCF fork with a brief explanation of what your model models or amendment fixes (see https://help.github.com/articles/using-pull-requests/).

To make merging with the central repository feasible it is strongly recommeded that you make any distinct sets of changes in separate feature branches from the central repo’s master branch and then merge them together to create your “develop” branch of the catalog with all your customisations.

Before opening a pull request, please add the author information and relevant scientific citations to comments within the annotations block of the document. It is also encouraged to create or link your model with an entry on Open Source Brain (see http://www.opensourcebrain.org/docs#Creating_Your_Own_Project).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ninemlcatalog-0.1.1.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

ninemlcatalog-0.1.1-py2.py3-none-any.whl (38.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ninemlcatalog-0.1.1.tar.gz.

File metadata

File hashes

Hashes for ninemlcatalog-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3726728f0911bdb806cecd953f0fae1d60d8848addecfeb3f90486b682730db6
MD5 9e60a4ad0f5d575c9be27cce734119bd
BLAKE2b-256 9cb1d045d50d996255983ca3717b27a7bc21af21edaa705b226d422df247d26e

See more details on using hashes here.

Provenance

File details

Details for the file ninemlcatalog-0.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for ninemlcatalog-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e5f033785df1e58ddb69379e5a109aceed75d12a8d6ef55e248a01f1e6489d37
MD5 69afcd9c9ba17e65d420b1a3fdeda82b
BLAKE2b-256 31d00c7702778fcd7dac74cf0000ddcd3225c4a625ecc57521f17c00b96c04cc

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page