Skip to content

Commit

Permalink
[USGS-R#7] update readme with container instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jsadler2 committed Apr 8, 2022
1 parent 2c8ad86 commit 8dca240
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
# drb_gridmet_tools

Repository with functions to aggregate raster data from pixel grid to vector aoi (hru polygon grid, polylines). This repository heavily relies on [grd2shp_xagg](https://github.com/rmcd-mscb/grd2shp_xagg) library, by [rmcd-mscb](https://github.com/rmcd-mscb)

# running the code
The pipeline specified in `Snakefile` will aggregate gridmet data to the polygons in the geo file specified. Currently, it's set up to pull the gridmet data from the start of the data archive (1979-01-01) to the present day.

## running with Docker
```
docker run jsadler2/gridmet-agg:v0.1 snakemake
```

## running with Singularity
We have to specify the full path to `snakemake` because it is not part of the system PATH in the Singularity container
```
singularity pull jsadler2/gridmet-agg:v0.1
singularity exec gridmet-agg_v0_1.sif /opt/conda/snakemake
```

0 comments on commit 8dca240

Please sign in to comment.