Repository to contain code that will parse source files into aind-data-schema models.
To use the software, in the root directory, run
pip install -e .[all]
It's possible to install just a small subset of dependencies. For example,
pip install -e .[bergamo]
To develop the code, run
pip install -e .[dev]
If you've found a bug in the schemas or would like to make a minor change, open an issue and please use the provided templates. If you'd like to propose a large change or addition, or generally have a question about how things work, head start a new Discussion!
Contributions are more than welcome for this project! If you'd like to develop the code, please follow the standards outlined in the contribution guide.
To generate the rst files source files for documentation, run
sphinx-apidoc -o docs/source/ src
Then to create the documentation HTML files, run
sphinx-build -b html docs/source/ docs/build/html
More info on sphinx installation can be found here.
More information including a user guide and contributor guidelines can be found at readthedocs.