Skip to content

Sample README.md File

Erik Kluzek edited this page Oct 10, 2025 · 1 revision

Author:

Purpose:

Briefly describe what this script does (e.g., processing biomass burning emissions, solar forcing, etc.).

Inputs:

List of the input files and where they live on campaign

Outputs:

List the output files the script produces and where they live on campaign

Usage:

Example command(s) to run the script.
If you have multiple scripts, please indicate (step 1, step 2, ...) 

Environments:

Machine run on (assume Derecho, but specifyif not)
conda or other environments used
modules needed for scripts to work

Notes:

Any special considerations (resolution dependence, conservative remapping, limitations).

Clone this wiki locally