DKIST data validator
Project description
An interface containing a validator, and a spec translator for DKIST specs:
SPEC-0122 Rev C: Data received from the summit
SPEC-0214 Rev ?: Data published by the Data Center (incomplete)
Features
Uses voluptuous schemas to validate a given input header against dkist specifications
3 keyword validations: type validation, required-ness validation, and value validation
Failure exceptions include a dictionary of validation failure causes
SPEC-0122 to SPEC-0214 translation
Installation
pip install dkist-header-validatorUsage
Currently, this package can be used to validate SPEC122 data or SPEC214 data. Please import the corresponding methods (spec122_validator and Spec122ValidationException, or spec214_validator, Spec214ValidationException).
This package can be used for validating data, or for validating and translating data (SPEC122 input only).
- Input data can be one of:
string file path
File like object
HDUList object
fits.header.Header object
Dictionary of header keys and values
To validate data:
>>> from dkist_header_validator import spec122_validator, Spec122ValidationException
>>> spec122_validator.validate('dkist_rosa0181200000_observation.fits')To validate and translate data:
>>> from dkist_header_validator import spec122_validator, Spec122ValidationException
>>> spec122_validator.validate_and_translate('dkist_rosa0181200000_observation.fits')- Within the validate and validate_and_translate methods, a series of flags can be set, otherwise they will take their default values:
extra: Default value is true (allow extra keys). This flag determines if extra keywords are allowed in the schema to be validated. Ingest validation should allow extra keys.
return_type: Default value is HDUList. This flag will determine the return type. Can be one of dict, Path, BytesIO, fits.header.Header, HDUList.
Examples
Validate a file:
>>> from dkist_header_validator import spec122_validator, Spec122ValidationException
>>> spec122_validator.validate('dkist_rosa0181200000_observation.fits', return_type=dict)
2. Validate and translate a file:
>>> from pathlib import Path
>>> spec122_validator.validate('dkist_rosa0181200000_observation.fits', return_type=Path)Validate and translate a file:
>>> from dkist_header_validator import spec122_validator, Spec122ValidationException
>>> spec122_validator.validate_and_translate('dkist_rosa0181200000_observation.fits')
3. Validate headers:
>>> spec122_validator.validate_and_translate('dkist_rosa0181200000_observation.fits')Validate headers:
>>> from dkist_header_validator import spec122_validator, Spec122ValidationException
>>> from astropy.io import fits
>>> hdus = fits.open('dkist_rosa0181200000_observation.fits')
>>> spec122_validator.validate(hdus[0].header, return_type=dict)This project is Copyright (c) AURA/NSO.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file dkist-header-validator-1.0.1.tar.gz.
File metadata
- Download URL: dkist-header-validator-1.0.1.tar.gz
- Upload date:
- Size: 24.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 27d9471d9cfef00ec6c52251c6e62e95e8764fcdffa5d818f9a254a971683461 |
|
| MD5 | c9cc30ed79c166db7aa487239e0d8b42 |
|
| BLAKE2b-256 | 2734344cae0e5d2a6ff99bc1c78318bfad364f7bec2fce2b95b1aa4e6800b394 |
