https://github.com/joangq/lyra
Climate Data Store form parser and grammar transformer for automatic code generation
https://github.com/joangq/lyra
api api-client api-wrapper cds cdsapi climate climate-data climate-data-store code-generation code-transformation data-collection data-science data-trans dataset json json-parser netcdf python wrapper wrapper-api
Last synced: 6 months ago
JSON representation
Climate Data Store form parser and grammar transformer for automatic code generation
- Host: GitHub
- URL: https://github.com/joangq/lyra
- Owner: joangq
- License: cc-by-4.0
- Created: 2024-11-16T16:14:11.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-17T23:30:49.000Z (11 months ago)
- Last Synced: 2025-02-01T10:42:32.840Z (8 months ago)
- Topics: api, api-client, api-wrapper, cds, cdsapi, climate, climate-data, climate-data-store, code-generation, code-transformation, data-collection, data-science, data-trans, dataset, json, json-parser, netcdf, python, wrapper, wrapper-api
- Language: Python
- Homepage:
- Size: 994 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Lyra is a Python library for parsing and transforming JSON-based forms into Python code. It provides tools to parse form definitions and generate corresponding Python code, facilitating the handling of data from the Climate Data Store (CDS) in Python applications.
## Installation
To install Lyra, clone the repository and install the required dependencies:
```sh
git clone https://github.com/joangq/lyra
cd lyra
pip install -r requirements.txt
```
## Usage
Here's a simple example of how to use Lyra to download data using the `cds_collections` module:
```python
from lyra import cds_collections
cds_collections.reanalysis_era5_single_levels.download(
product_type = "reanalysis",
data_format = "netcdf",
variable = "2m_temperature",
year = "2020",
month = "01",
day = "01",
time = "12:00",
)
```
This example demonstrates how to use the generated functions in `cds_collections` to request data directly from the CDS and save it to a file.
## How It Works
Lyra processes JSON form definitions from the CDS and transforms them into Python code that can be used to interact with the CDS API. The process involves three main components:
- **Parser**: The parser, implemented in `lyra.parser`, reads the JSON form definitions and creates an abstract syntax tree (AST) representation.
- **Transformer**: The transformer, found in `lyra.transformer`, takes the AST and transforms it into an intermediate representation suitable for code generation.
- **Translator**: The translator, located in `lyra.translator`, generates Python code from the intermediate representation, producing a set of functions that mirror the data request forms on the CDS.
This automated process allows users to interact with the CDS programmatically, without having to manually construct API requests.
## Repository Structure
The Lyra repository is organized as follows:
```python
Lyra/
├── src/ # Main code (notebooks + library)
│ └── lyra/ # Library code
│ ├── parser/ # - JSON Form to AST parser
│ ├── transformer/ # - AST to intermediate representation
│ ├── translator/ # - IR to Python code (target cds_collections/)
│ ├── cds_collections/ # - Autogenerated target
│ └── auth/ # - Wrapper for dotenv-based authentication
├── data/ # Example forms from the CDS.
├── tests/ # Unit tests
├── assets/ # Graphical assets
└── .env # Expected environament variables file.
```
---
