README.md

Virtual Brain Lab Aquarium

Collection of Pydantic models describing data objects passed between Virtual Brain Lab projects.

Corresponding JSON schema and C# files are generated automatically and are located in the models directory.

Usage

For C# structs or JSON schemas, copy or reference whatever models you need from the models directory.

To use the Pydantic models directly in Python, install the package with

pip install vbl-aquarium

Then import the models with

from vbl_aquarium.models.module_name import ModelName

replacing .module_name and ModelName with the desired model.

Further Documentation

For more information regarding updating models and each model's specification, see the VBL Aquarium documentation.