Name | vbl-aquarium JSON |
Version |
1.0.0
JSON |
| download |
home_page | None |
Summary | Collection of Pydantic models describing data objects passed between Virtual Brain Lab projects. |
upload_time | 2025-02-26 05:13:13 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.8 |
license | MIT |
keywords |
neuroscience
pydantic
virtualbrainlab
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Virtual Brain Lab Aquarium

[](https://github.com/VirtualBrainLab/vbl-aquarium/actions/workflows/build-models.yml)
[](https://github.com/VirtualBrainLab/vbl-aquarium/actions/workflows/static-analysis.yml)
[](https://pydantic.dev)
[](https://github.com/pypa/hatch)
[](https://github.com/astral-sh/ruff)
[](https://microsoft.github.io/pyright/)
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
```bash
pip install vbl-aquarium
```
Then import the models with
```python
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](https://aquarium.virtualbrainlab.org).
Raw data
{
"_id": null,
"home_page": null,
"name": "vbl-aquarium",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "neuroscience, pydantic, virtualbrainlab",
"author": null,
"author_email": "Daniel Birman <dbirman@uw.edu>, Kenneth Yang <kjy5@uw.edu>",
"download_url": "https://files.pythonhosted.org/packages/df/54/d5b11cd0d34822a9798a539bc5a5fbbc752ce8cdb50d6306827257c81f53/vbl_aquarium-1.0.0.tar.gz",
"platform": null,
"description": "# Virtual Brain Lab Aquarium\n\n\n[](https://github.com/VirtualBrainLab/vbl-aquarium/actions/workflows/build-models.yml)\n[](https://github.com/VirtualBrainLab/vbl-aquarium/actions/workflows/static-analysis.yml)\n[](https://pydantic.dev)\n[](https://github.com/pypa/hatch)\n[](https://github.com/astral-sh/ruff)\n[](https://microsoft.github.io/pyright/)\n\nCollection of Pydantic models describing data objects passed between Virtual\nBrain Lab projects.\n\nCorresponding JSON schema and C# files are generated automatically and are\nlocated in the `models` directory.\n\n## Usage\n\nFor C# structs or JSON schemas, copy or reference whatever models you need from\nthe `models` directory.\n\nTo use the Pydantic models directly in Python, install the package with\n\n```bash\npip install vbl-aquarium\n```\n\nThen import the models with\n\n```python\nfrom vbl_aquarium.models.module_name import ModelName\n```\n\nreplacing `.module_name` and `ModelName` with the desired model.\n\n## Further Documentation\n\nFor more information regarding updating models and each model's specification,\nsee the VBL\nAquarium [documentation](https://aquarium.virtualbrainlab.org).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Collection of Pydantic models describing data objects passed between Virtual Brain Lab projects.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://github.com/VirtualBrainLab/vbl-aquarium/blob/main/README.md",
"Issues": "https://github.com/VirtualBrainLab/vbl-aquarium/issues",
"Source": "https://github.com/VirtualBrainLab/vbl-aquarium"
},
"split_keywords": [
"neuroscience",
" pydantic",
" virtualbrainlab"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2fc387e9904a7d4880e7b6ee5e6beaffc29b576b380e379fe48026d7742d33c4",
"md5": "5c1528efac8d4592fcbd10b9cbe5e5e8",
"sha256": "a6d1fc19b9a62cb14652d0849dc6366f990e965ae0377514fedd1ba27d4819b4"
},
"downloads": -1,
"filename": "vbl_aquarium-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c1528efac8d4592fcbd10b9cbe5e5e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13697,
"upload_time": "2025-02-26T05:13:11",
"upload_time_iso_8601": "2025-02-26T05:13:11.737121Z",
"url": "https://files.pythonhosted.org/packages/2f/c3/87e9904a7d4880e7b6ee5e6beaffc29b576b380e379fe48026d7742d33c4/vbl_aquarium-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "df54d5b11cd0d34822a9798a539bc5a5fbbc752ce8cdb50d6306827257c81f53",
"md5": "53c8fb891d61b5c01681f3a9a6321b62",
"sha256": "f50c8d024fcb6f319c5647330ff897532fb62bb8c6159fe548b59c2bf223bafc"
},
"downloads": -1,
"filename": "vbl_aquarium-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "53c8fb891d61b5c01681f3a9a6321b62",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 39172,
"upload_time": "2025-02-26T05:13:13",
"upload_time_iso_8601": "2025-02-26T05:13:13.011585Z",
"url": "https://files.pythonhosted.org/packages/df/54/d5b11cd0d34822a9798a539bc5a5fbbc752ce8cdb50d6306827257c81f53/vbl_aquarium-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-26 05:13:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VirtualBrainLab",
"github_project": "vbl-aquarium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vbl-aquarium"
}