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

Edit CF-Compliance-Checker.md

parent de1b3e10
Loading
Loading
Loading
Loading
+29 −0
Original line number Diff line number Diff line
@@ -49,6 +49,35 @@ pip install cfchecker

---

## Quick Start with conda

To make it easy for collaborators to run the script, an `environment.yml` file is provided in the scripts directory.


### 1. Create the environment
```bash
conda env create -f /Users/jminz/Documents/Project/2024/lafi-data-management/scripts/cf_compliance/environment.yml

### 2. Activate the environment
```bash
conda activate lafi-cf-checker

### 3. Run the script
```bash
python scripts/cf_compliance/check_cf_compliance.py <parent_directory> [CF_version] [--all] [--csv] [--excel]

### Examples

#### Check only the first file in each subdir
```bash
python scripts/cf_compliance/check_cf_compliance.py /data/netcdf_files

#### Check all files and export results
```bash
python scripts/cf_compliance/check_cf_compliance.py /data/netcdf_files 1.8 --all --csv --excel

---

## Usage

```bash