OSBModelValidation 0.2.18__tar.gz

OSBModelValidation-0.2.18/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include omv/engines/utils/genesis_utils.g
+recursive-include omv/schemata *

OSBModelValidation-0.2.18/OSBModelValidation.egg-info/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.1
+Name: OSBModelValidation
+Version: 0.2.18
+Summary: Open Source Brain Model validation
+Home-page: https://github.com/OpenSourceBrain/osb-model-validation
+Author: Boris Marin, Padraig Gleeson
+Author-email: borismarin@gmail.com
+License: LGPL-3.0-only
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Description-Content-Type: text/markdown
+Requires-Dist: PyYAML
+Requires-Dist: numpy
+Requires-Dist: pyrx
+Requires-Dist: pathlib; python_version < "3.4"
+Requires-Dist: docopt
+Requires-Dist: importlib-metadata; python_version < "3.8"
+
+[![Continuous builds](https://github.com/OpenSourceBrain/osb-model-validation/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenSourceBrain/osb-model-validation/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/osb-model-validation)](https://pypi.org/project/osb-model-validation/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/osb-model-validation)](https://pypi.org/project/osb-model-validation/)
+[![GitHub](https://img.shields.io/github/license/OpenSourceBrain/osb-model-validation)](https://github.com/OpenSourceBrain/osb-model-validation/blob/master/LICENSE.lesser)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/OpenSourceBrain/osb-model-validation)](https://github.com/OpenSourceBrain/osb-model-validation/pulls)
+[![GitHub issues](https://img.shields.io/github/issues/OpenSourceBrain/osb-model-validation)](https://github.com/OpenSourceBrain/osb-model-validation/issues)
+[![Gitter](https://badges.gitter.im/NeuroML/community.svg)](https://gitter.im/NeuroML/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+------------------------------------------
+
+# OSB Model Validation
+
+Tools for automated model validation in [Open Source Brain](http://www.opensourcebrain.org) projects, which can also be used for testing model behaviour on many [simulation engines](https://github.com/OpenSourceBrain/osb-model-validation/tree/master/omv/engines) both:
+
+- on your local machine when developing models
+- on [GitHub Actions](https://github.com/features/actions), to ensure tests pass on every commit.
+
+To see this framework in action, click on some of the green buttons below:
+
+|  OSB project   |   Tests on GitHub Actions    |  Test workflow script |
+|----------|:-------------:|:------:|
+|[FitzHugh Nagumo](http://www.opensourcebrain.org/projects/fitzhugh-nagumo-fitzhugh-1969) | [![Continuous build using OMV](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/actions/workflows/omv-ci.yml/badge.svg)](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/actions/workflows/omv-ci.yml) | [omv-ci.yml](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/.github/workflows/omv-ci.yml) |
+|[Auditory cortex network](http://www.opensourcebrain.org/projects/acnet2)| [![Continuous build using OMV](https://github.com/OpenSourceBrain/ACnet2/actions/workflows/omv-ci.yml/badge.svg)](https://github.com/OpenSourceBrain/ACnet2/actions/workflows/omv-ci.yml) | [omv-ci.yml](https://github.com/OpenSourceBrain/ACnet2/blob/master/.github/workflows/omv-ci.yml) |
+| [SBML Showcase](http://www.opensourcebrain.org/projects/sbmlshowcase)| [![Continuous build using OMV](https://github.com/OpenSourceBrain/sbmlshowcase/actions/workflows/omv-ci.yml/badge.svg)](https://github.com/OpenSourceBrain/sbmlshowcase/actions/workflows/omv-ci.yml) | [omv-ci.yml](https://github.com/OpenSourceBrain/sbmlshowcase/blob/master/.github/workflows/omv-ci.yml) |
+
+This framework has been used to test the 30+ NeuroML and PyNN models described in the [Open Source Brain paper (Gleeson et al. 2019)](https://www.cell.com/neuron/fulltext/S0896-6273(19)30444-1), and [many more](https://github.com/OpenSourceBrain/.github/blob/main/testsheet/README.md).
+
+## Installation
+
+Quick system-wide install:
+
+``` bash
+pip install osb-model-validation
+```
+
+Or you can install from cloned repository (preferably in a virtual environment):
+
+``` bash
+git clone https://github.com/OpenSourceBrain/osb-model-validation.git
+cd osb-model-validation
+pip install .
+```
+
+## Instructions
+
+Any _Open Source Brain_ project can have automated testing incorporated.
+For an overview of the various Open Source Brain projects with OMV tests, see https://github.com/OpenSourceBrain/.github/blob/main/testsheet/README.md (note not all of these use OMV yet).
+
+Setting up validation for a model and simulation written in NeuroML2/LEMS requires two additional steps:
+
+- write a <b>M</b>odel <b>E</b>mergent <b>P</b>roperties (_mep_) file.
+- write the corresponding <b>O</b>SB <b>M</b>odel <b>T</b>est (_omt_) file.
+
+
+### Write MEP files
+
+Depending on the size of your model, you can run validation on the full fledged model, or you can create smaller stripped down versions that test particular aspects of the model.
+Here is an example LEMS file for the FitzHugh-Nagumo model on Open Source Brain: [LEMS_FitzHugNagamo.xml](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/NeuroML2/LEMS_FitzHughNagumo.xml).
+
+``` yaml
+# Script for running automated tests on OSBrain, see https://github.com/OpenSourceBrain/osb-model-validation
+
+system: The Fitzhugh-Nagumo model, classical parameters
+
+experiments:
+  experiment 1, free run:
+    expected:
+      spike times: [2.24, 39.82, 76.53, 113.24, 149.94, 186.65, 223.36, 260.07, 296.78, 333.49, 370.2]
+```
+
+MEP files include information on what is expected from the simulation run.
+OMV will run the simulation based on the OMT files (which we'll see below), and compare the output to the information provided in MEP files.
+Multiple _experiments_ can be mentioned in the MEP file, and each project can have multiple MEP files.
+
+The MEP file for the FitzHugh-Nagumo model is [here](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/fhn.mep).
+It includes a single experiment, with the expected spike times that the simulation run should generate.
+
+### Writing OMT files
+
+OMT files include information on simulating the model for validation.
+The FitzHugh-Nagumo model on Open Source Brain includes multiple OMT files that can be seen [here](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/tree/master/NeuroML2).
+
+- Each OMT file specifies a _target_ file, which is the LEMS simulation file to be run.
+
+- Each OMT file specifies an _engine_ that OMV supports.
+    Engines are simulators that OMV should use to run the model. See [here](https://github.com/OpenSourceBrain/osb-model-validation/tree/master/omv/engines) for the current list.
+    For example, the [.test.fhn.jnml.omt](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/NeuroML2/.test.fhn.jnml.omt) file uses the `jNeuroML` engine, which implies that the model should be run using plain jNeuroML (and not any of the simulators that jNeuroML supports, like NEURON).
+
+``` yaml
+# Script for running automated tests on OSB, see https://github.com/OpenSourceBrain/osb-model-validation
+
+target: LEMS_FitzHughNagumo.xml
+engine: jNeuroML
+mep: ../fhn.mep
+experiments:
+  experiment 1, free run:
+    observables:
+      spike times:
+        file:
+          path: ./fhn.dat
+          columns: [0,1]
+          scaling: [1000, 1]
+        spike detection:
+          method: derivative
+        tolerance: 2.185696883946938e-16
+```
+
+- Each OMT file specifies the MEP file that the output of its simulation run should be compared to.
+    In this case, we use the same MEP file for all OMT files.
+
+- Finally, like MEP files, OMT files also include _experiments_.
+    The names of the experiments in the OMT files must correspond to those used in the MEP files, so that OMV knows what section of the OMT and MEP files are related to each other.
+    In each experiment, we specify our _observables_, which are to be compared to the information provided in the MEP file.
+    Here, we inform OMV that we are observing _spike times_, which will be recorded by the simulation run in `fhn.dat`.
+    We also inform OMV what columns of this file the information is to be extracted from, and if these columns need to be scaled before they are compared to the data provided in the MEP file.
+    Finally, while simulations can save spike times directly and OMV will compare these to the MEP file, if the simulation is recording membrane potentials, OMV can also be asked to detect spikes from this data using the _spike detection_ section.
+    The _tolerance_ key tells OMV what the acceptable difference between the expected and observed data values is.
+
+This is the OMT file to validate the same model using the `jNeuroML_NEURON` engine: [.test.fhn.jnmlnrn.omt](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/NeuroML2/.test.fhn.jnmlnrn.omt).
+It uses the same MEP file, and observes the same recorded information.
+It only tells OMV to use a different simulation engine:
+
+``` yaml
+# Script for running automated tests on OSB, see https://github.com/OpenSourceBrain/osb-model-validation
+
+target: LEMS_FitzHughNagumo.xml
+engine: jNeuroML_NEURON
+mep: ../fhn.mep
+experiments:
+  experiment 1, free run:
+    observables:
+      spike times:
+        file:
+          path: ./fhn.dat
+          columns: [0,1]
+          scaling: [1000, 1]
+        spike detection:
+          method: derivative
+        tolerance: 0
+```
+### Running validation tests locally
+
+If you have installed OMV successfully, you can now run all the OMV tests locally, by running this command:
+
+    omv all
+
+Adding the `-V` flag prints more details on successful/failed runs. Learn more about the options that `omv` can take by running `omv --help`.
+
+To see what [engines](https://github.com/OpenSourceBrain/osb-model-validation/tree/master/omv/engines) are currently installed (and what their versions are) type:
+
+    omv list -V  
+
+Running validation tests locally ensures that you can quickly check if any changes you have made to the model cause changes to its specific outcomes.
+Since you can run the validation with different [engines](https://github.com/OpenSourceBrain/osb-model-validation/tree/master/omv/engines) to use different simulators, this also allows you to quickly verify that your model gives similar results using these different tools.
+
+
+### Running tests automatically on GitHub Actions
+
+To use OMV with GHA, copy an existing configuration file, e.g. https://github.com/OpenSourceBrain/ACnet2/blob/master/.github/workflows/omv-ci.yml and place it in the required repository.

OSBModelValidation-0.2.18/OSBModelValidation.egg-info/SOURCES.txt

@@ -0,0 +1,124 @@
+MANIFEST.in
+README.md
+pyproject.toml
+setup.cfg
+OSBModelValidation.egg-info/PKG-INFO
+OSBModelValidation.egg-info/SOURCES.txt
+OSBModelValidation.egg-info/dependency_links.txt
+OSBModelValidation.egg-info/entry_points.txt
+OSBModelValidation.egg-info/requires.txt
+OSBModelValidation.egg-info/top_level.txt
+omv/__init__.py
+omv/autogen.py
+omv/experiment.py
+omv/find_tests.py
+omv/omt_mep_parser.py
+omv/omv_util.py
+omv/parse_omt.py
+omv/tally.py
+omv/analyzers/__init__.py
+omv/analyzers/activation.py
+omv/analyzers/analyzer.py
+omv/analyzers/dryrun.py
+omv/analyzers/input_resistance.py
+omv/analyzers/morphology.py
+omv/analyzers/rates.py
+omv/analyzers/resting.py
+omv/analyzers/spikes.py
+omv/analyzers/temperature.py
+omv/analyzers/timeseries.py
+omv/analyzers/utils/__init__.py
+omv/analyzers/utils/filenode.py
+omv/analyzers/utils/timeseries.py
+omv/common/__init__.py
+omv/common/inout.py
+omv/engines/__init__.py
+omv/engines/arbor_.py
+omv/engines/brian1.py
+omv/engines/brian2_.py
+omv/engines/eden_.py
+omv/engines/engine.py
+omv/engines/genesis.py
+omv/engines/getarbor.py
+omv/engines/getbrian1.py
+omv/engines/getbrian2.py
+omv/engines/geteden.py
+omv/engines/getgenesis.py
+omv/engines/getjlems.py
+omv/engines/getjnml.py
+omv/engines/getlibsbml.py
+omv/engines/getmoose.py
+omv/engines/getnest.py
+omv/engines/getnetpyne.py
+omv/engines/getneuroconstruct.py
+omv/engines/getnml2.py
+omv/engines/getnrn.py
+omv/engines/getoctave.py
+omv/engines/getpylems.py
+omv/engines/getpyneuroml.py
+omv/engines/getpynn.py
+omv/engines/jlems.py
+omv/engines/jneuroml.py
+omv/engines/jneuromlbrian.py
+omv/engines/jneuromlbrian2.py
+omv/engines/jneuromleden.py
+omv/engines/jneuromlmoose.py
+omv/engines/jneuromlnetpyne.py
+omv/engines/jneuromlnetpyne_np2.py
+omv/engines/jneuromlnetpyne_np4.py
+omv/engines/jneuromlnrn.py
+omv/engines/jneuromlpynnnrn.py
+omv/engines/jneuromlvalidate.py
+omv/engines/jneuromlvalidatev1.py
+omv/engines/moose_.py
+omv/engines/nestsli.py
+omv/engines/netpyne_.py
+omv/engines/netpyne__np2.py
+omv/engines/netpyne__np4.py
+omv/engines/neuron_.py
+omv/engines/octave.py
+omv/engines/pylems.py
+omv/engines/pylemsnml2.py
+omv/engines/pynest.py
+omv/engines/pyneuroconstruct.py
+omv/engines/pyneuroml_.py
+omv/engines/pyneuromlvalidatesbml.py
+omv/engines/pyneuron.py
+omv/engines/pynn.py
+omv/engines/pynnbrian1.py
+omv/engines/pynnbrian2.py
+omv/engines/pynnnest.py
+omv/engines/pynnneuroml.py
+omv/engines/pynnneuron.py
+omv/engines/utils/__init__.py
+omv/engines/utils/genesis_utils.g
+omv/engines/utils/wdir.py
+omv/schemata/mep.yaml
+omv/schemata/types/expected.yaml
+omv/schemata/types/experiment.yaml
+omv/schemata/types/observable.yaml
+omv/schemata/types/protocol.yaml
+omv/schemata/types/protocol_properties.yaml
+omv/schemata/types/base/observable_datafile.yaml
+omv/schemata/types/base/observable_literal.yaml
+omv/schemata/types/base/observables.yaml
+omv/schemata/types/base/test/observable_datafile.yaml
+omv/schemata/types/base/test/observable_literal.1.yaml
+omv/schemata/types/base/test/observable_literal.3.yaml
+omv/schemata/types/test/expected.1.yaml
+omv/schemata/types/test/expected.2.yaml
+omv/schemata/types/test/expected.3.yaml
+omv/schemata/types/test/expected.4.yaml
+omv/schemata/types/test/experiment.1.yaml
+omv/schemata/types/test/experiment.2.yaml
+omv/schemata/types/test/observable.yaml
+omv/schemata/types/test/protocol.1.yaml
+omv/schemata/types/test/protocol.2.yaml
+omv/test/__init__.py
+omv/test/test_rates.py
+omv/test/test_types.py
+omv/validation/__init__.py
+omv/validation/rx_validator.py
+omv/validation/utils.py
+omv/validation/validate.py
+omv/validation/validate_mep.py

OSBModelValidation-0.2.18/OSBModelValidation.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

OSBModelValidation-0.2.18/OSBModelValidation.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+omv = omv.omv_util:main

OSBModelValidation-0.2.18/OSBModelValidation.egg-info/requires.txt

@@ -0,0 +1,10 @@
+PyYAML
+numpy
+pyrx
+docopt
+
+[:python_version < "3.4"]
+pathlib
+
+[:python_version < "3.8"]
+importlib-metadata

OSBModelValidation-0.2.18/OSBModelValidation.egg-info/top_level.txt

@@ -0,0 +1 @@
+omv

OSBModelValidation-0.2.18/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.1
+Name: OSBModelValidation
+Version: 0.2.18
+Summary: Open Source Brain Model validation
+Home-page: https://github.com/OpenSourceBrain/osb-model-validation
+Author: Boris Marin, Padraig Gleeson
+Author-email: borismarin@gmail.com
+License: LGPL-3.0-only
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Description-Content-Type: text/markdown
+Requires-Dist: PyYAML
+Requires-Dist: numpy
+Requires-Dist: pyrx
+Requires-Dist: pathlib; python_version < "3.4"
+Requires-Dist: docopt
+Requires-Dist: importlib-metadata; python_version < "3.8"
+
+[![Continuous builds](https://github.com/OpenSourceBrain/osb-model-validation/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenSourceBrain/osb-model-validation/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/osb-model-validation)](https://pypi.org/project/osb-model-validation/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/osb-model-validation)](https://pypi.org/project/osb-model-validation/)
+[![GitHub](https://img.shields.io/github/license/OpenSourceBrain/osb-model-validation)](https://github.com/OpenSourceBrain/osb-model-validation/blob/master/LICENSE.lesser)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/OpenSourceBrain/osb-model-validation)](https://github.com/OpenSourceBrain/osb-model-validation/pulls)
+[![GitHub issues](https://img.shields.io/github/issues/OpenSourceBrain/osb-model-validation)](https://github.com/OpenSourceBrain/osb-model-validation/issues)
+[![Gitter](https://badges.gitter.im/NeuroML/community.svg)](https://gitter.im/NeuroML/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+------------------------------------------
+
+# OSB Model Validation
+
+Tools for automated model validation in [Open Source Brain](http://www.opensourcebrain.org) projects, which can also be used for testing model behaviour on many [simulation engines](https://github.com/OpenSourceBrain/osb-model-validation/tree/master/omv/engines) both:
+
+- on your local machine when developing models
+- on [GitHub Actions](https://github.com/features/actions), to ensure tests pass on every commit.
+
+To see this framework in action, click on some of the green buttons below:
+
+|  OSB project   |   Tests on GitHub Actions    |  Test workflow script |
+|----------|:-------------:|:------:|
+|[FitzHugh Nagumo](http://www.opensourcebrain.org/projects/fitzhugh-nagumo-fitzhugh-1969) | [![Continuous build using OMV](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/actions/workflows/omv-ci.yml/badge.svg)](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/actions/workflows/omv-ci.yml) | [omv-ci.yml](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/.github/workflows/omv-ci.yml) |
+|[Auditory cortex network](http://www.opensourcebrain.org/projects/acnet2)| [![Continuous build using OMV](https://github.com/OpenSourceBrain/ACnet2/actions/workflows/omv-ci.yml/badge.svg)](https://github.com/OpenSourceBrain/ACnet2/actions/workflows/omv-ci.yml) | [omv-ci.yml](https://github.com/OpenSourceBrain/ACnet2/blob/master/.github/workflows/omv-ci.yml) |
+| [SBML Showcase](http://www.opensourcebrain.org/projects/sbmlshowcase)| [![Continuous build using OMV](https://github.com/OpenSourceBrain/sbmlshowcase/actions/workflows/omv-ci.yml/badge.svg)](https://github.com/OpenSourceBrain/sbmlshowcase/actions/workflows/omv-ci.yml) | [omv-ci.yml](https://github.com/OpenSourceBrain/sbmlshowcase/blob/master/.github/workflows/omv-ci.yml) |
+
+This framework has been used to test the 30+ NeuroML and PyNN models described in the [Open Source Brain paper (Gleeson et al. 2019)](https://www.cell.com/neuron/fulltext/S0896-6273(19)30444-1), and [many more](https://github.com/OpenSourceBrain/.github/blob/main/testsheet/README.md).
+
+## Installation
+
+Quick system-wide install:
+
+``` bash
+pip install osb-model-validation
+```
+
+Or you can install from cloned repository (preferably in a virtual environment):
+
+``` bash
+git clone https://github.com/OpenSourceBrain/osb-model-validation.git
+cd osb-model-validation
+pip install .
+```
+
+## Instructions
+
+Any _Open Source Brain_ project can have automated testing incorporated.
+For an overview of the various Open Source Brain projects with OMV tests, see https://github.com/OpenSourceBrain/.github/blob/main/testsheet/README.md (note not all of these use OMV yet).
+
+Setting up validation for a model and simulation written in NeuroML2/LEMS requires two additional steps:
+
+- write a <b>M</b>odel <b>E</b>mergent <b>P</b>roperties (_mep_) file.
+- write the corresponding <b>O</b>SB <b>M</b>odel <b>T</b>est (_omt_) file.
+
+
+### Write MEP files
+
+Depending on the size of your model, you can run validation on the full fledged model, or you can create smaller stripped down versions that test particular aspects of the model.
+Here is an example LEMS file for the FitzHugh-Nagumo model on Open Source Brain: [LEMS_FitzHugNagamo.xml](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/NeuroML2/LEMS_FitzHughNagumo.xml).
+
+``` yaml
+# Script for running automated tests on OSBrain, see https://github.com/OpenSourceBrain/osb-model-validation
+
+system: The Fitzhugh-Nagumo model, classical parameters
+
+experiments:
+  experiment 1, free run:
+    expected:
+      spike times: [2.24, 39.82, 76.53, 113.24, 149.94, 186.65, 223.36, 260.07, 296.78, 333.49, 370.2]
+```
+
+MEP files include information on what is expected from the simulation run.
+OMV will run the simulation based on the OMT files (which we'll see below), and compare the output to the information provided in MEP files.
+Multiple _experiments_ can be mentioned in the MEP file, and each project can have multiple MEP files.
+
+The MEP file for the FitzHugh-Nagumo model is [here](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/fhn.mep).
+It includes a single experiment, with the expected spike times that the simulation run should generate.
+
+### Writing OMT files
+
+OMT files include information on simulating the model for validation.
+The FitzHugh-Nagumo model on Open Source Brain includes multiple OMT files that can be seen [here](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/tree/master/NeuroML2).
+
+- Each OMT file specifies a _target_ file, which is the LEMS simulation file to be run.
+
+- Each OMT file specifies an _engine_ that OMV supports.
+    Engines are simulators that OMV should use to run the model. See [here](https://github.com/OpenSourceBrain/osb-model-validation/tree/master/omv/engines) for the current list.
+    For example, the [.test.fhn.jnml.omt](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/NeuroML2/.test.fhn.jnml.omt) file uses the `jNeuroML` engine, which implies that the model should be run using plain jNeuroML (and not any of the simulators that jNeuroML supports, like NEURON).
+
+``` yaml
+# Script for running automated tests on OSB, see https://github.com/OpenSourceBrain/osb-model-validation
+
+target: LEMS_FitzHughNagumo.xml
+engine: jNeuroML
+mep: ../fhn.mep
+experiments:
+  experiment 1, free run:
+    observables:
+      spike times:
+        file:
+          path: ./fhn.dat
+          columns: [0,1]
+          scaling: [1000, 1]
+        spike detection:
+          method: derivative
+        tolerance: 2.185696883946938e-16
+```
+
+- Each OMT file specifies the MEP file that the output of its simulation run should be compared to.
+    In this case, we use the same MEP file for all OMT files.
+
+- Finally, like MEP files, OMT files also include _experiments_.
+    The names of the experiments in the OMT files must correspond to those used in the MEP files, so that OMV knows what section of the OMT and MEP files are related to each other.
+    In each experiment, we specify our _observables_, which are to be compared to the information provided in the MEP file.
+    Here, we inform OMV that we are observing _spike times_, which will be recorded by the simulation run in `fhn.dat`.
+    We also inform OMV what columns of this file the information is to be extracted from, and if these columns need to be scaled before they are compared to the data provided in the MEP file.
+    Finally, while simulations can save spike times directly and OMV will compare these to the MEP file, if the simulation is recording membrane potentials, OMV can also be asked to detect spikes from this data using the _spike detection_ section.
+    The _tolerance_ key tells OMV what the acceptable difference between the expected and observed data values is.
+
+This is the OMT file to validate the same model using the `jNeuroML_NEURON` engine: [.test.fhn.jnmlnrn.omt](https://github.com/OpenSourceBrain/FitzHugh-Nagumo/blob/master/NeuroML2/.test.fhn.jnmlnrn.omt).
+It uses the same MEP file, and observes the same recorded information.
+It only tells OMV to use a different simulation engine:
+
+``` yaml
+# Script for running automated tests on OSB, see https://github.com/OpenSourceBrain/osb-model-validation
+
+target: LEMS_FitzHughNagumo.xml
+engine: jNeuroML_NEURON
+mep: ../fhn.mep
+experiments:
+  experiment 1, free run:
+    observables:
+      spike times:
+        file:
+          path: ./fhn.dat
+          columns: [0,1]
+          scaling: [1000, 1]
+        spike detection:
+          method: derivative
+        tolerance: 0
+```
+### Running validation tests locally
+
+If you have installed OMV successfully, you can now run all the OMV tests locally, by running this command:
+
+    omv all
+
+Adding the `-V` flag prints more details on successful/failed runs. Learn more about the options that `omv` can take by running `omv --help`.
+
+To see what [engines](https://github.com/OpenSourceBrain/osb-model-validation/tree/master/omv/engines) are currently installed (and what their versions are) type:
+
+    omv list -V  
+
+Running validation tests locally ensures that you can quickly check if any changes you have made to the model cause changes to its specific outcomes.
+Since you can run the validation with different [engines](https://github.com/OpenSourceBrain/osb-model-validation/tree/master/omv/engines) to use different simulators, this also allows you to quickly verify that your model gives similar results using these different tools.
+
+
+### Running tests automatically on GitHub Actions
+
+To use OMV with GHA, copy an existing configuration file, e.g. https://github.com/OpenSourceBrain/ACnet2/blob/master/.github/workflows/omv-ci.yml and place it in the required repository.