aind-data-schema-models
Installation
aind-data-schema-models is a dependency of aind-data-schema. You should not need to install it directly.
Contributing
Install the dev dependencies:
pip install -e .[dev]
How to add a new model class
tl;dr
Add new classes to the _generators/models/*.csv files or create new files containing Enum-derived classes directly in the src folder.
Run ./run_all.sh in the top-level folder to rebuild models from their CSV files.
Details
The model class files, brain_atlas.py etc, are auto-generated. You should never need to modify the class files directly.
Instead, take a look at the jinja2 templates in the folder _generators/templates. The filename of the template is used to pull the corresponding .csv file and populate the data DataFrame. In the template you can pull data from the various columns and use them to populate each of the fields in your class.
To re-build all the models, run the run_all.sh bash script in the root folder, which loops through the template files and runs them through the generate_code function.
There are a few special cases, e.g. if data are missing in columns they will show up as float: nan. See the organizations.txt template for examples of how to handle this.
Documentation
Internal registries need to be enumerated in the aind-data-schema file src/aind_data_schema/utils/docs/registries_generator.py in the variable registries. This list controls what classes will have documentation automatically generated and cross-referenced correctly.
If you add a new external registry, you need to write the documentation manually in the aind-data-schema file docs/source/aind_data_schema_models/external.md.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aind_data_schema_models-0.0.2.tar.gz.
File metadata
- Download URL: aind_data_schema_models-0.0.2.tar.gz
- Upload date:
- Size: 362.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ee76410b1913faf0d678037d1fe3bf97091b60545b27cbdf87c33acd1f485f53
|
|
| MD5 |
9c0bf84fcaceb011b22618cf74a9240c
|
|
| BLAKE2b-256 |
efc4e3d3685f17f1fa3e515522b29a29378e7892d76ad4ba654d181b07a9b4b0
|
File details
Details for the file aind_data_schema_models-0.0.2-py3-none-any.whl.
File metadata
- Download URL: aind_data_schema_models-0.0.2-py3-none-any.whl
- Upload date:
- Size: 336.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a4cfe1b06855907b796b60a6b09316441b7c9f5c491bdd5d13018e24a4325ebf
|
|
| MD5 |
4294cd530a73abec6d17444080e3f393
|
|
| BLAKE2b-256 |
22052fdaeee1a8a078d9086bd819e16573a7bd54e332c3c817428554a267f0c8
|
