Developing a Gen3 Data Dictionary
This repository aims to provide the documentation, learning materials, and software tools to facilitate the creation of a data model in Gen3.
Pre-Reading: Please become familiar with some core data modelling concepts before starting.
Using Gen3SchemaDev as a data modelling tool
Null description placeholders
gen3schemadev validate warns about description: null placeholders anywhere in the dictionary (commonly in _definitions.yaml's enum definitions). The Gen3 metaschema requires descriptions to be strings; null placeholders cause "No Description" in the data-dictionary viewer and metaschema validation failures that surface on resolved node schemas, far from the offending definition. Remove the null description keys to resolve the warning.
Deep dive into Gen3 Data Modelling
Special Thanks to Marion Shadbolt for providing the source material
- Gen3 Dictionary Overview
- Gen3 Schema Explained
- Example of a Gen3 Schema yaml
- Handy tips
- FAIR Concepts for Data Modelling
For Developers
Installation and testing
# To install
pip install poetry
poetry install
source $(poetry env info --path)/bin/activate
gen3schemadev --version
# To run tests
poetry run pytest
Contributing
Gen3SchemaDev is an open source project, and we highly encourage any contributions and PRs. Specifically we need the community to help with the following:
- Keeping the gen3 metaschema up to date
- Adding business rule logic to the rule validator module.
- For example, a node with the category
data_fileshould have a collection of required data file properties such as md5sum, filesize, etc.
- For example, a node with the category
For PRs, please follow the contributing guidelines.
License
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 gen3schemadev-2.6.2.tar.gz.
File metadata
- Download URL: gen3schemadev-2.6.2.tar.gz
- Upload date:
- Size: 42.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.12.13 Linux/6.17.0-1020-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cc1efaeaa3805ba08ea39c9c0fe347ce1946a97a16d58f07acd5417571c77103
|
|
| MD5 |
1cedc8b0f108ae6bbd237a9aa18202c5
|
|
| BLAKE2b-256 |
1828dc50a0909c6c8147cf1abe8498e839913e9699c27ead5ce9fac53c824619
|
File details
Details for the file gen3schemadev-2.6.2-py3-none-any.whl.
File metadata
- Download URL: gen3schemadev-2.6.2-py3-none-any.whl
- Upload date:
- Size: 49.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.4.1 CPython/3.12.13 Linux/6.17.0-1020-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
34a39b16906f6151d6072ca2f097dd23ed04d9cd732399b30d5a4bbc4944db6f
|
|
| MD5 |
c853d0eaec850076380365d6cf2105a4
|
|
| BLAKE2b-256 |
5e6650c2e4abf17592597385a6a3cb0f8a4c96d8eba59f51e784e71753a4c1b7
|
