Skip to content

Commit

Permalink
Update path to schema (#180)
Browse files Browse the repository at this point in the history
* Update path to schema

* Update incorrect link to experiment metadata schema

* Fix typo

* Update docs/management/source.rst

Co-authored-by: Dougie Squire <[email protected]>

---------

Co-authored-by: Dougie Squire <[email protected]>
  • Loading branch information
rbeucher and dougiesquire committed Jul 31, 2024
1 parent 8c81cdd commit a808275
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/management/catalog.rst
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
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

0 comments on commit a808275

Please sign in to comment.