-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 0a1ccd5c37a1b61a73af6861b88fec34 | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
docs.neuroml.org |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Page not found | ||
|
||
Sorry, the page you were looking could not be found. | ||
Please use the search function to look for information in the documentation. | ||
For any issues, please {ref}`contact us <contact>`. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
(devdocs:devsop)= | ||
# Contribution guidelines | ||
|
||
Thank you for your interest in contributing to NeuroML. | ||
Welcome! | ||
|
||
This page documents the contribution guidelines for all NeuroML related repositories. | ||
|
||
Please do remember that these are *guidelines* but not rules that must be strictly followed. | ||
We think these are reasonable ideas to follow and they help us maintain a high code quality while making it easier and more efficient for all of us to work together. | ||
However, there may be cases where they can not be followed, and that's fine too. | ||
|
||
(devdocs:devsop:coc)= | ||
## Code of conduct | ||
|
||
All NeuroML projects are governed by the {ref}`Code of Conduct <coc>`. | ||
By participating, you are expected to uphold this code. | ||
Please report unacceptable behaviour to the moderators of the communication channel you are in. | ||
|
||
(devdocs:devsop:repos)= | ||
## Structure of repositories | ||
|
||
- All NeuroML repositories use the [Git](https://git-scm.com/) version control system. | ||
- Contributions are made using [pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). | ||
- Each NeuroML software tool resides in its own GitHub repository under the [NeuroML GitHub Organization](https://github.com/NeuroML), apart from [libNeuroML](https://github.com/NeuralEnsemble/libNeuroML) which is developed in collaboration with the [NeuralEnsemble community](http://neuralensemble.org/) and so lives under their GitHub organization. | ||
- LEMS repositories are housed under the [LEMS GitHub Organization](https://github.com/LEMS). | ||
|
||
You can find links to these on the respective pages for each {ref}`software tool <userdocs:software>`. | ||
|
||
The NeuroML standard itself (schema and ComponentType definitions) is housed in its own repository [here](https://github.com/NeuroML/NeuroML2). | ||
|
||
(devdocs:devsop:repos:zenhub) | ||
### Kanban board on Zenhub | ||
|
||
An overview of the various repositories, tasks, issues, and so on can be seen on the [NeuroML Kanban board on Zenhub](https://app.zenhub.com/workspaces/neuroml-development-605c92c7c670460016e497ab/board?filterLogic=any&repos=7225220,6579766,7225426,299352189,78101103,129064858,8460738,6171449,6171626,27832592,78100679,6171646,3740176,4614078,7146844,4326891&showPipelineDescriptions=false). | ||
|
||
|
||
(devdocs:devsop:versioning)= | ||
## Versioning | ||
|
||
All NeuroML repositories (including the standard) follow [Semantic versioning](https://semver.org/). | ||
This means that the version string consists of three components: `MAJOR.MINOR.PATCH`: | ||
|
||
- the MAJOR version is incremented when incompatible API changes are made, | ||
- the MINOR version is incremented when functionality is added in a backwards compatible manner, and | ||
- the PATCH version is incremented when backwards compatible bug fixes are made. | ||
|
||
(devdocs:devsop:branches)= | ||
## Git branches | ||
|
||
- Please develop against the `development` branch in all repositories. | ||
This branch is merged into `master` via a pull request when a new release is made. | ||
This ensures that all tests are run at each step to verify correctness. | ||
As a result, the `master` branch of all repositories holds the stable version of the standard and tools, while the `development` branch holds the next, unstable version that is being worked upon. | ||
|
||
- For branch names, please consider using the [Git flow](https://nvie.com/posts/a-successful-git-branching-model/) naming convention (not mandatory but strongly suggested): | ||
|
||
- prefix feature branches with `feat/` or `enh/` (for enhancement) | ||
- prefix bugfix branches with `bugfix/` or `fix/` | ||
- pull requests addressing specific tickets may also mention them in the branch name. E.g., `bugfix/issue-22`. | ||
|
||
(devdocs:devsop:commits)= | ||
## Git commits | ||
|
||
Git commit messages are extremely important because they allow us to nicely track the complete development history of the project. | ||
Here are some guidelines on writing good commit messages: | ||
|
||
- Each commit should ideally only address one issue. | ||
It should be self-contained (should not group together lots of changes). | ||
Tip: use `git add -p` to break your work down into logical, small commits). | ||
- Write good commit messages. | ||
Read [this post](https://chris.beams.io/posts/git-commit/) to see how to write meaningful, useful commit messages and why they are important. | ||
- We strongly suggest using the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. | ||
In short: | ||
|
||
- Each commit is of the form `<type>[optional scope]: description`, followed by the text body of the commit after a blank line, and then any optional references etc. as footer. | ||
- The `type` can be one of: `fix`, `feat`, `build`, `chore`, `ci`, `docs`, `refactor`, `perf`, `test`, and so on depending on what the commit is doing. | ||
- Any backwards incompatible, breaking change must be clearly noted in the commit using the `BREAKING CHANGE` phrase. | ||
This corresponds to a major version update (as noted above in the versioning section). | ||
|
||
(devdocs:devsop:style:java)= | ||
## Code style: Java | ||
|
||
TODO | ||
|
||
(devdocs:devsop:style:python)= | ||
## Code style: Python | ||
|
||
- While Python 2 is still supported even though it is [no longer supported by the Python community](https://pythonclock.org), given that most Python modules (numpy/scipy/matplotlib/sphinx) have dropped support for this deprecated Python version, NeuroML will also drop support in the near future. | ||
Therefore, we strongly suggest using Python 3. | ||
- For Python repositories, please use [Black](https://black.readthedocs.io/) to format your code before committing and submitting a pull request. | ||
- We also strongly suggest linting using [flake8](https://flake8.pycqa.org/). | ||
- Please use [type hints](https://docs.python.org/3/library/typing.html?highlight=type%20hint) in your code and run [mypy](https://mypy.readthedocs.io/en/stable/) to test it for correctness. | ||
You can see the [mypy cheatsheet](https://mypy.readthedocs.io/en/stable/cheat_sheet.html) to quickly see how to do this. | ||
Since NeuroML is currently still supporting Python 2, we use the Python 2 style to maintain compatibility (this also works with Python 3). | ||
- Deprecations should be clearly noted in the code, and in the commit message. | ||
You may use the [Sphinx deprecated directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-deprecated) along with the Python [DeprecationWarning](https://docs.python.org/3/library/exceptions.html#DeprecationWarning), for example. | ||
|
||
(devdocs:devsop:docs)= | ||
## Documentation | ||
|
||
All tools include their own documentation in their repositories. | ||
Please feel free to improve this documentation and submit pull requests. | ||
|
||
When contributing fixes and enhancements, please remember to document your classes/functions and code in general. | ||
Not only does this allow others to understand your code, it also allows us to auto-generate documentation using various tools. | ||
|
||
- For the Java repositories, please use the standard [Javadoc](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html) syntax. | ||
- For the Python repositories, please document your code using the standard [Sphinx reStructuredText](https://www.sphinx-doc.org) system. | ||
For functions and so on, you can use the provided [fields](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html?#python-signatures). | ||
|
||
Where applicable, please add examples and so on to the software documentation to ensure that users can find the information quickly. | ||
Additionally, please remember to consider if this primary NeuroML documentation here needs to be updated. | ||
|
||
Please use [Semantic Line Breaks](https://sembr.org/) wherever possible. | ||
|
||
(devdocs:devsop:testing)= | ||
## Testing | ||
|
||
- Before submitting a pull request, please run the various tests to confirm your changes. | ||
You can see how they are run in the various GitHub workflow files (in the `.github/workflows/` folder in each repository). | ||
They will be run on all pull requests automatically so you can also verify your changes there. | ||
- For a new feature addition, please remember to include a unit test. | ||
- For a bug fix, please include a regression test. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
(devdocs:overview)= | ||
# Overview | ||
|
||
This section will contain information for those who wish to **contribute to the development** of the NeuroML standard and associated tools. | ||
|
||
An overview of the NeuroML **release process** can be found {ref}`here <devdocs:release>`. | ||
|
||
The relationship of NeuroML to a number of other tools and standards in computational neuroscience, | ||
and the practical steps taken thus far to ensure interoperability, can be found {ref}`here <devdocs:interaction>`. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
(devdocs:interaction)= | ||
# Interaction with other languages and standards | ||
|
||
```{admonition} Needs work | ||
TODO: Add more information to each of these | ||
``` | ||
|
||
(devdocs:interaction:pynn)= | ||
## PyNN | ||
|
||
[https://github.com/NeuroML/NeuroML2/issues/73](https://github.com/NeuroML/NeuroML2/issues/73) | ||
|
||
(devdocs:interaction:sbml)= | ||
## SBML | ||
|
||
[https://github.com/OpenSourceBrain/SBMLShowcase](https://github.com/OpenSourceBrain/SBMLShowcase) | ||
|
||
|
||
(devdocs:interaction:sonata)= | ||
## Sonata | ||
|
||
[https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1007696](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1007696) | ||
|
||
|
||
(devdocs:interaction:nineml)= | ||
## NineML & SpineML | ||
|
||
[https://github.com/OpenSourceBrain/NineMLShowcase](https://github.com/OpenSourceBrain/NineMLShowcase) | ||
|
||
|
||
(devdocs:interaction:mdf)= | ||
## ModECI MDF | ||
|
||
[http://www.modeci.org/](http://www.modeci.org/) | ||
|
||
(devdocs:interaction:swc)= | ||
## SWC | ||
|
||
http://www.neuronland.org/NLMorphologyConverter/MorphologyFormats/SWC/Spec.html | ||
http://www.neuromorpho.org/myfaq.jsp |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
(devdocs:release)= | ||
# Release Process | ||
|
||
## Overview | ||
|
||
In general, work is carried out in the **development** branches of the [main NeuroML repositories](https://github.com/NeuroML/.github/blob/main/testsheet/README.md) | ||
and these are merged to **master** branches on a new major release, e.g. move from NeuroML v2.1 to v2.2. | ||
|
||
A single page showing the **status of the automated test** as well as any **open Pull Requests** on all of the core NeuroML repositories can be found [here](https://github.com/NeuroML/.github/blob/main/testsheet/README.md). | ||
|
||
## Steps for new major release | ||
|
||
These are the steps required for a new release of the NeuroML development tools. | ||
|
||
| Task | Version this was last done | | ||
| --- | --- | | ||
| Commit final stable work in development branches | v2.3 | | ||
| Make releases (not just tag - generates DOI) previous development versions of individual repos | v2.3 | | ||
| Increment all version numbers - to distinguish release from previous development version | v2.3 | | ||
| Test all development branches - rerun GitHub Actions at least once | v2.3 | | ||
| Recheck all READMEs & docs | v2.3 | | ||
| Run & check [test.py](https://github.com/NeuroML/NeuroML2/blob/master/test.py) in NeuroML2 repo | v2.3 | | ||
| Check through issues for closed & easily closable ones | v2.3 | | ||
| Update version in {ref}`documentation pages <userdocs:neuromlv2>` | v2.3 | | ||
| Update [HISTORY.md](https://github.com/NeuroML/NeuroML2/blob/master/HISTORY.md) in NeuroML2 | v2.3 | | ||
| pylems: Update README; Merge to master; Tag release; Release to pip | v2.3 | | ||
| libNeuroML: Update README; Retest; Merge to master; Tag release; Release to pip; Check [installation docs](https://libneuroml.readthedocs.org/en/latest/install.html) | v2.3 | | ||
| pyNeuroML: Update Readme; Tag release; Release to pip | v2.3 | | ||
| NeuroMLlite: Update Readme; Tag release; Release to pip | v2.3 | | ||
| Java repositories ({ref}`jNeuroML <jNeuroML>`, org.neuroml.* etc.): Merge development to master; Tag releases | v2.3 | | ||
| Rebuild jNeuroML & commit to [jNeuroMLJar](https://sourceforge.net/p/neuroml/code/HEAD/tree/jNeuroMLJar/) and use latest for [jNeuroML for OMV](https://github.com/OpenSourceBrain/osb-model-validation/blob/master/omv/engines/getjnml.py#L8) | v2.3 | | ||
| Add new binary release on [https://github.com/NeuroML/jNeuroML/releases](https://github.com/NeuroML/jNeuroML/releases) | v2.3 | | ||
| Update version used in [neuroConstruct](https://github.com/NeuralEnsemble/neuroConstruct) | v2.3 | | ||
| Update docs on [http://docs.neuroml.org](https://docs.neuroml.org) | v2.3 | | ||
| Update version on [COMBINE website](https://github.com/combine-org/combine-org.github.io/blob/master/content/authors/NeuroML/_index.md) | v2.2 | | ||
| ANNOUNCE (mailing list, Twitter) | v2.2 | | ||
| Increment version numbers in all development branches | v2.3 | | ||
| DOI on [Zenodo](https://doi.org/10.5281/zenodo.593108) | v2.3 | | ||
| Update NeuroML [milestones](https://github.com/NeuroML/NeuroML2/milestones) | v2.2 | | ||
| New release of [neuroConstruct](https://github.com/NeuralEnsemble/neuroConstruct/releases) | v2.3 | | ||
| Test toolchain on Windows... | v2.0 | |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
(devdocs:updating_standard)= | ||
# Making changes to the NeuroML standard | ||
|
||
The NeuroML standard is stored in two sets of files, each serving a specific purpose: | ||
|
||
- the NeuroML [XML Schema Definition](https://en.wikipedia.org/wiki/XML_Schema_(W3C)) (XSD) file: this specifies the structure of a valid NeuroML XML file: what XML tags may be used and the how they are related | ||
- the NeuroML [LEMS](http://lems.github.io/LEMS/) ComponentType definition XML files: these include the definitions of the NeuroML standard ComponentTypes in LEMS constructs, which include the mathematical details underlying these ComponentTypes | ||
|
||
These files are housed in the [NeuroML](https://github.com/NeuroML/NeuroML2/) repository. | ||
|
||
The XSD schema file is used to validate NeuroML XML files, as shown in the {ref}`page on validating NeuroML files <userdocs:validating_models>`. | ||
Further, the NeuroML Python model in {ref}`libNeuroML <libneuroml>` is also generated from the XSD file using the [generateDS](http://www.davekuhlman.org/generateDS.html) utility. | ||
|
||
The LEMS ComponentType definition XML files are also used for a series of additional validation tests, and since they include the details of the underlying dynamics for all ComponentTypes, they are also used for the simulation of NeuroML models either using the reference LEMS interpreter, {ref}`jLEMS <jlems>`, or through automated code generation for supported simulation platforms (via {ref}`jNeuroML <jneuroml>`). | ||
Additionally, the LEMS definition files are also used the generate the {ref}`human readable schema documentation <userdocs:neuromlv2>` included in this documentation resource. | ||
|
||
The two sets of files are therefore, tightly coupled. | ||
Any changes to the XSD file must also be followed by corresponding changes to the LEMS definition files. | ||
|
||
(devdocs:updating_standard:proc)= | ||
## Procedure | ||
|
||
```{admonition} PR waiting | ||
TODO: A pull request to include the `transfer_docs_to_xsd.py` script in the repository is in review here: https://github.com/NeuroML/NeuroML2/pull/172 | ||
``` | ||
|
||
The suggested way of making changes to these files is via pull requests to the NeuroML repository which will undergo review by the NeuroML editorial board and the development team. | ||
As noted in the {ref}`general contribution guidelines <devdocs:devsop>`, the `development` branch tracks the next release of the NeuroML standard. | ||
So, all pull request must be made against the `development` branch. | ||
|
||
- New ComponentTypes, and their elements (parameters, variables etc.) that are added in the LEMS definition XML files should be properly documented. | ||
- After both sets of files have been modified, please run the `transfer_docs_to_xsd.py` script in the `scripts` folder to copy documentation over from the XML files to the XSD schema file. This script will also run basic sanity checks to ensure that all ComponentTypes in the LEMS XML definition files are represented in the XSD schema file and vice-versa. | ||
- Please run `xmllint` on the files to ensure they are formatted correctly. | ||
- Please make individual commits for changes to the XSD file, and the XML files. This ensures that their change history is clearly maintained. | ||
|
||
(devdocs:updating_standard:schema_docs)= | ||
## Regenerating schema documentation | ||
|
||
Once the pull request has been merged in the NeuroML repository, the {ref}`human readable schema documentation included in this documentation resource <userdocs:neuromlv2>` must be updated. | ||
This is done by running the [generate-jupyter-ast.py](https://github.com/NeuroML/Documentation/blob/master/scripts/schemas/generate-jupyter-ast.py) script included in the [documentation source repository](https://github.com/NeuroML/Documentation). | ||
This will read the LEMS XML definition files and regenerate the corresponding documentation pages. | ||
A pull request can then be opened with the updated pages. | ||
|
||
|
||
|
||
(devdocs:updating_standard:org_neuroml_model)= | ||
## Updating the Java API: org.neuroml.model | ||
|
||
TODO: Document what needs to be done for https://github.com/NeuroML/org.neuroml.model | ||
|
||
|
||
|
||
(devdocs:updating_standard:libneuroml)= | ||
## Updating the Python API: libNeuroML | ||
|
||
```{admonition} PR waiting | ||
TODO: A pull request to include the `regenerate-nml.sh` script in the repository is in review here: https://github.com/NeuralEnsemble/libNeuroML/pull/110 | ||
``` | ||
|
||
Any changes to the XSD schema file require regeneration of the [Python object model in libNeuroML](https://github.com/NeuralEnsemble/libNeuroML/blob/development/neuroml/nml/nml.py): | ||
|
||
- copy over the updated XSD schema file to the `neuroml/nml/` directory in the `development` branch | ||
- commit the new XSD file | ||
- run the `regenerate-nml.sh` script to regenerate and reformat `nml.py` | ||
- build and install libNeuroML into a new virtual environment | ||
- run all tests using `pytest` | ||
- run all examples and ensure that they run correctly (please see the [GitHub actions workflow](https://github.com/NeuralEnsemble/libNeuroML/blob/master/.github/workflows/ci.yml#L44) for more information) | ||
- if all checks pass successfully, a pull request can be opened | ||
|
||
(devdocs:updating_standard:c_api)= | ||
## Updating the C++ API | ||
|
||
TODO: Document what needs to be done for https://github.com/NeuroML/NeuroML_API/ | ||
|