Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update path to schema #180

Merged
merged 4 commits into from
Jul 31, 2024
Merged

Update path to schema #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00db395
Update path to schema
rbeucher Jul 31, 2024
66e159c
Update incorrect link to experiment metadata schema
dougiesquire Jul 31, 2024
d81e734
Fix typo
dougiesquire Jul 31, 2024
3169c93
Update docs/management/source.rst
rbeucher Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/management/catalog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ intake-dataframe-catalog or load an existing one. Intake-ESM datastore sources c
:ref:`translators` are specified to translate the metadata in source datastores to be compatible with the
catalog schema.

When :code:`access_nri_intake.catalog` is first imported, it downloads and parses the a specific commit
of the schema at https://github.com/ACCESS-NRI/schema/blob/main/experiment_asset.json. The raw schema is
stored in the variable :code:`access_nri_intake.catalog.EXP_JSONSCHEMA` (more on this later) and a
version with the "required" field replaced with :code:`access_nri_intake.catalog.CORE_COLUMNS` is stored
When :code:`access_nri_intake.catalog` is first imported, it downloads and parses a specific commit of the
schema at https://github.com/ACCESS-NRI/schema/tree/main/au.org.access-nri/model/output/experiment-metadata.
The raw schema is stored in the variable :code:`access_nri_intake.catalog.EXP_JSONSCHEMA` (more on this later)
and a version with the "required" field replaced with :code:`access_nri_intake.catalog.CORE_COLUMNS` is stored
in the variable :code:`access_nri_intake.catalog.CATALOG_JSONSCHEMA` (this is to allow this field to be
customized). The latter defines what metadata must be included in the intake-dataframe-catalog, and what
types and fields are allowed. Subsequent imports read the downloaded schema, unless the schema is changed
Expand Down
2 changes: 1 addition & 1 deletion docs/management/source.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ or they can be built using the :code:`access_nri_intake.source` sub-package. Cur
:code:`access_nri_intake.source` only supports building Intake-ESM datastore sources.

When :code:`access_nri_intake.source` is first imported, it downloads and parses a specific commit of the
schema at https://github.com/ACCESS-NRI/schema/blob/main/file_asset.json and stores it in the variable
schema at https://github.com/ACCESS-NRI/schema/tree/main/au.org.access-nri/model/output/file-metadata and stores it in the variable
:code:`access_nri_intake.source.ESM_JSONSCHEMA`. This schema defines what metadata must be included in an
Intake-ESM catalog, and what types and fields are allowed. Subsequent imports read the downloaded schema,
unless the schema is changed (see :ref:`schema`), in which case the new schema is downloaded.
Expand Down
Loading