Skip to content

Commit

Permalink
Update docs, lint fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Joni Herttuainen committed Nov 17, 2023
1 parent 715a715 commit 2d7147b
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 1 deletion.
9 changes: 9 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
Changelog
=========

Version v2.1.0
--------------

New Features
~~~~~~~~~~~~
- Added simulation config validation
- Added a new commandline subcommand: ``validate-simulation``


Version v2.0.2
--------------

Expand Down
25 changes: 25 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,31 @@ Or a python free function:
errors = validate("my/circuit/path/circuit_config.json")
Simulation Validation
~~~~~~~~~~~~~~~~~~~~~

Similarly to circuit validation, Blue Brain SNAP also provides a SONATA simulation validator for verifying simulation configs.

Currently, the validator only verifies that:

- all the mandatory fields are present in the config file
- all the properties in the `simulation config specification <https://sonata-extension.readthedocs.io/en/latest/sonata_simulation.html>`__ have correct data types and accepted values

This functionality is provided by either the cli function:

.. code-block:: shell
bluepysnap validate-simulation my/circuit/path/simulation_config.json
Or a python free function:

.. code-block:: python3
from bluepysnap.simulation_validation import validate
errors = validate("my/circuit/path/simulation_config.json")
Acknowledgements
----------------

Expand Down
1 change: 0 additions & 1 deletion bluepysnap/circuit_validation.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import logging
from pathlib import Path

import click
import h5py
import numpy as np
import pandas as pd
Expand Down
1 change: 1 addition & 0 deletions bluepysnap/simulation_validation.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
"""Standalone module that validates Sonata simulation. See ``validate-simulation`` function."""
from pathlib import Path

from bluepysnap import schemas
Expand Down

0 comments on commit 2d7147b

Please sign in to comment.