AllenNeuralDynamics / aind-data-schema

A library that defines AIND data schema and validates JSON.

MIT License

23 stars 17 forks source link

Docs: how to generate derived data assets and have them picked up by indexer #1150

Open dbirman opened 2 weeks ago

dbirman commented 2 weeks ago

User story

As a user, I want to be able to make derived assets and know they will be picked up by the indexer. This information is missing from https://aind-data-schema.readthedocs.io/en/latest/data_organization.html

Acceptance criteria

[ ] Documentation describes steps needed to build derived data assets and have them correctly index including: how to generate asset manually/automatically, how to copy metadata and make derived data_description, which new metadata files should be added to derived assets, and how to tag assets to ensure the indexer sees them

Sprint Ready Checklist

[ ] 1. Acceptance criteria defined
[ ] 2. Team understands acceptance criteria
[ ] 3. Team has defined solution / steps to satisfy acceptance criteria
[ ] 4. Acceptance criteria is verifiable / testable
[ ] 5. External / 3rd Party dependencies identified
[ ] 6. Ticket is prioritized and sized

Notes

dbirman commented 2 weeks ago

David is going to write a first draft of this and I'll add details