# ADC-compliance-checker
Arctic Data Centre compliance checker is a python based tool for those wanting to submit data to the Artic Data Centre. The python module can be used to check if files fullfill the metadata requirements listed [here](https://adc.met.no/node/4).
The compliance checker can be used in combination with CF and ACDD chekcers to enusre NetCDF files adhere to the FAIR principles for data management.
## Usage
### Command Line
```sh
adc-compliance-checker <file_path>
```
#### Output Example
The tool will provide feeback on the compliance status of the file:
```plaintext
Summary:
========
- File metadata has all required attributes and they are non-empty.
Result:
=======
✅ file.nc metadata is ADC compliant!
```
or
```plaintext
File metadata is missing or has empty the following required global attributes:
===============================================================================
- id: Required if not hosted by MET (MISSING)
- naming_authority: Required if not hosted by MET (MISSING)
- summary: Required (MISSING)
- ...
Summary:
========
- 23 required global attributes are missing.
- Please refer to the ADC compliance documentation to resolve these issues:
https://adc.met.no/node/4
Result:
=======
❌ file.nc metadata is not ADC compliant!
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Alessimc/adc-compliance-checker",
"name": "adc-compliance-checker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Alessio Canclini",
"author_email": "alessioc@met.no",
"download_url": "https://files.pythonhosted.org/packages/a4/16/d6cbcddd6a44f253aca204c0f6c2f005267d8cad0d8eec7f8d4112cc3df8/adc-compliance-checker-0.2.1.tar.gz",
"platform": null,
"description": "# ADC-compliance-checker\nArctic Data Centre compliance checker is a python based tool for those wanting to submit data to the Artic Data Centre. The python module can be used to check if files fullfill the metadata requirements listed [here](https://adc.met.no/node/4).\n\nThe compliance checker can be used in combination with CF and ACDD chekcers to enusre NetCDF files adhere to the FAIR principles for data management.\n\n## Usage\n\n### Command Line\n```sh\nadc-compliance-checker <file_path>\n```\n\n#### Output Example\n\nThe tool will provide feeback on the compliance status of the file:\n```plaintext\nSummary:\n========\n- File metadata has all required attributes and they are non-empty.\n\nResult:\n=======\n\n\u2705 file.nc metadata is ADC compliant!\n\n```\nor\n```plaintext\nFile metadata is missing or has empty the following required global attributes:\n===============================================================================\n - id: Required if not hosted by MET (MISSING)\n - naming_authority: Required if not hosted by MET (MISSING)\n - summary: Required (MISSING)\n - ...\n\nSummary:\n========\n- 23 required global attributes are missing.\n- Please refer to the ADC compliance documentation to resolve these issues:\n https://adc.met.no/node/4\n\nResult:\n=======\n\n\u274c file.nc metadata is not ADC compliant!\n\n```\n\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "ADC Compliance Checker",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/Alessimc/adc-compliance-checker"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "111eec7815ffa686e1b9463c6d0ffaa998aa7d176d54269215200dc8cb514203",
"md5": "58602c67a9634eff922dac13005823e1",
"sha256": "1b6b5a8ed9f0895a2cae32959a9ea8b21234a6d60f9a5fc9aed219086db635bf"
},
"downloads": -1,
"filename": "adc_compliance_checker-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "58602c67a9634eff922dac13005823e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 16685,
"upload_time": "2024-08-08T13:25:01",
"upload_time_iso_8601": "2024-08-08T13:25:01.116592Z",
"url": "https://files.pythonhosted.org/packages/11/1e/ec7815ffa686e1b9463c6d0ffaa998aa7d176d54269215200dc8cb514203/adc_compliance_checker-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a416d6cbcddd6a44f253aca204c0f6c2f005267d8cad0d8eec7f8d4112cc3df8",
"md5": "d2910bf1d1a67d97a1c741c10e947039",
"sha256": "831b54d668b7bc2a71c19bf99f5c03e6e091ca5203cdf26e506663e7f9b924fe"
},
"downloads": -1,
"filename": "adc-compliance-checker-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "d2910bf1d1a67d97a1c741c10e947039",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 15768,
"upload_time": "2024-08-08T13:25:45",
"upload_time_iso_8601": "2024-08-08T13:25:45.503256Z",
"url": "https://files.pythonhosted.org/packages/a4/16/d6cbcddd6a44f253aca204c0f6c2f005267d8cad0d8eec7f8d4112cc3df8/adc-compliance-checker-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-08 13:25:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Alessimc",
"github_project": "adc-compliance-checker",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "adc-compliance-checker"
}
JSON
