Table of Contents
About the project
glodformat is a Python package that helps validate the format of netCDF files derived
from GLOD and other specifications.
This library was developed for the LIME Toolbox, under the LIME projects development efforts. More information about LIME can be found on lime.uva.es.
Collaborators
The LIME project is managed, financed and supported by the European Space Agency (ESA).
The project is a collaboration between multiple institutions, including:
- NPL (National Physics Laboratory, United Kingdom)
- UVa (Universidad de Valladolid, Spain)
- VITO (Vlaamse Instelling voor Technologisch Onderzoek, Belgium)
Getting started
Prerequisites
- Python >= 3.10
Installation
The package is available at PyPI and can be installed with:
pip install glodformat
Another option is installing the python package and its dependencies directly from the cloned repository in editable mode by using:
pip install -e .
Usage
import glodformat
# Functions accept both paths or loaded xarray datasets
glodformat.validate_srf("response.nc")
glodformat.validate_moon_observation("moon_obs.nc")
glodformat.validate_srf_for_obs("response.nc", "moon_obs.nc")
Roadmap
- Fully support checking if an observation file is correctly represented by a SRF file
- Add support for LIME Toolbox related formats
Development Guide
Versioning
Version changes and descriptions are stored in the CHANGELOG. This file is updated each time a new version is released.
Setting Up the Environment
To prepare your environment for development, testing or deployment, follow these steps:
-
Install Pre-commit Hooks Install the
pre-commithooks to automatically check code styling:pre-commit install
- When you commit changes,
blackwill check your code for styling errors. - If errors are found, they will be corrected, and the commit will be aborted to allow you to review the changes.
- If you're satisfied, reattempt the commit.
- When you commit changes,
-
Install Python Dependencies
Install the python package dependencies listed in the
requirements.txtfile, preferably in a python virtual enironment:pip install -r requirements.txt
Testing
Run the following commands to ensure the code works as expected:
- Unit Tests
To perform unit tests:python3 -m unittest
License
Distributed under the LGPL-v3 License. See LGPL v3 for more information.
Acknowledgements
Metadata
Release files for glodformat 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| glodformat-0.0.1.tar.gz | 258.3 kB | Without provenance | Details for glodformat-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| glodformat-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for glodformat-0.0.1-py3-none-any.whl |
Total release size: 461.9 kB
Release files / glodformat-0.0.1.tar.gz
| Download URL | glodformat-0.0.1.tar.gz |
|---|---|
| Size | 258.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9d8a9302f5035bb69414c98d03c4c5f516a86de4676402346946012b88b958f2
|
|
BLAKE2b-256 checksum How to use checksums |
b102afcd002dd96d91c810bd5a768935da9615d76e065889c13def9c3728bf1e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / glodformat-0.0.1-py3-none-any.whl
| Download URL | glodformat-0.0.1-py3-none-any.whl |
|---|---|
| Size | 203.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bec5521bd2f4c51e93ccf32c16734b54a5a202946f1afe3f6b405501aa5d3593
|
|
BLAKE2b-256 checksum How to use checksums |
5b5c4add3e7d35c71cfdca96318f65ee20b8daea8298e535e95d56121664b8df
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Security for glodformat 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.