Commit c4304e11 authored by Jonathan  Minz's avatar Jonathan Minz
Browse files

Edit README.md

parent 0d5f9ee8
Loading
Loading
Loading
Loading
+34 −1
Original line number Diff line number Diff line
@@ -10,7 +10,23 @@ This repository provides scripts and tools supporting the **data management** co

## Included Tools

### CF Compliance Checker
### Doppler LiDAR Conversion (`scripts/DL_conversion/`)
A set of notebooks, sample files, and metadata for converting **Halo Photonics Doppler LiDAR** `.hpl` files into **CF-compliant NetCDF**.  

Contents include:
- `Lidar_HPL_to_NetCDF_Conversion.ipynb` → Jupyter notebook for converting `.hpl` data into NetCDF.  
- `convert_hpl_to_obs4mips_notebook.ipynb` → Conversion notebook for producing **obs4MIPs-compliant** outputs.  
- `Stare_115_20240423_00.hpl` → Example Doppler LiDAR input file.  
- `hpl_doppler_lidar_output.nc` → Example NetCDF output file.  
- `obs4mips_attributes.json` → Attribute definitions for obs4MIPs conversion.  

Further documentation:  
- [HPL Doppler LiDAR File Format Documentation](https://aidaho-edu.uni-hohenheim.de/gitlab/lafe_test/lafi-data-management/-/wikis/home/HPL-Doppler-LiDAR-File-Format-Documentation)  
- [Doppler LiDAR HPL to CF-Compliant NetCDF Conversion](https://aidaho-edu.uni-hohenheim.de/gitlab/lafe_test/lafi-data-management/-/wikis/home/Doppler-LiDAR-HPL-to-CF-Compliant-NetCDF-Conversion)

---

### CF Compliance Checker (`scripts/cf_compliance/`)
A Python-based script that automates validation of NetCDF files against the [CF (Climate and Forecast) Metadata Conventions](http://cfconventions.org/).  

It:
@@ -24,6 +40,23 @@ It:

---

## Repository Structure

lafi-data-management/
├── OLD/
├── docs/
│ └── cf_compliance/
│ └── CF-Compliance-Checker.md
├── scripts/
│ ├── DL_conversion/
│ │ ├── Lidar_HPL_to_NetCDF_Conversion.ipynb
│ │ ├── Stare_115_20240423_00.hpl
│ │ ├── convert_hpl_to_obs4mips_notebook.ipynb
│ │ ├── hpl_doppler_lidar_output.nc
│ │ └── obs4mips_attributes.json
│ └── cf_compliance/
│ └── check_cf_compliance.py
└── README.md