NASA-IMPACT / pyQuARC

The pyQuARC tool reads and evaluates metadata records with a focus on the consistency and robustness of the metadata. pyQuARC flags opportunities to improve or add to contextual metadata information in order to help the user connect to relevant data products. pyQuARC also ensures that information common to both the data product and the file-level metadata are consistent and compatible. pyQuARC frees up human evaluators to make more sophisticated assessments such as whether an abstract accurately describes the data and provides the correct contextual information. The base pyQuARC package assesses descriptive metadata used to catalog Earth observation data products and files. As open source software, pyQuARC can be adapted and customized by data providers to allow for quality checks that evolve with their needs, including checking metadata not covered in base package.
Apache License 2.0
19 stars 0 forks source link

Add documentation for checks #152

Closed slesaad closed 3 years ago

slesaad commented 3 years ago

Motivation To make pyQuARC easier for the users, it is set up in a way that a new rule can be added just by adding entries to a set of JSON files. A new rule basically points to a checks that is already implemented.

We need documentation of all the available checks so the user can just go through it and find the check that they need to create the new rule. It should include the description of what the check does and the check id that can be used in the JSON files.

Changes made Restructured the schema files rule_mapping.json and checks.json, such that the checks can be reused and users have to only make changes in the rule_mapping.json file. Changes include:

Deliverable The documentation for all the available checks is provided in the file CHECKS.md

slesaad commented 3 years ago

pyQuARC: Documentation of the available checks (2)

code-geek commented 3 years ago

LGTM