-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from UofU-Cryosphere/GMD/readme
Change README
- Loading branch information
Showing
3 changed files
with
112 additions
and
105 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,106 +1,7 @@ | ||
| # Automated Water Supply Model | ||
| # Fork of the Automated Water Supply Model (AWSM) | ||
|
|
||
| [](https://badge.fury.io/gh/USDA-ARS-NWRC%2Fawsm) | ||
| [](https://doi.org/10.5281/zenodo.898158) | ||
| [](https://awsm.readthedocs.io) | ||
| [](https://hub.docker.com/r/usdaarsnwrc/awsm/) | ||
| [](https://hub.docker.com/r/usdaarsnwrc/awsm/) | ||
| [](https://coveralls.io/github/USDA-ARS-NWRC/awsm?branch=HEAD) | ||
| [](https://travis-ci.org/USDA-ARS-NWRC/awsm) | ||
| This is a fork of the [USDA-ARS-NWRC AWSM](https://github.com/USDA-ARS-NWRC/awsm) repo with the | ||
| model development state used for publication in | ||
| [Geoscientific Model Development](https://gmd.copernicus.org/). | ||
|
|
||
|
|
||
| Automated Water Supply Model (AWSM) was developed at the USDA Agricultural | ||
| Research Service (ARS) in Boise, ID. AWSM was designed to streamline the work | ||
| flow used by the ARS to forecast the water supply of multiple water basins. | ||
| AWSM standardizes the steps needed to distribute weather station data with SMRF, | ||
| run an energy and mass balance with iSnobal, and process the results, while | ||
| maintaining the flexibility of each program. | ||
|
|
||
|  | ||
|
|
||
| ## Quick Start | ||
|
|
||
| The fastest way to get up and running with AWSM is to use the docker images that | ||
| are pre-built and can deployed cross platform. | ||
|
|
||
| To build AWSM natively from source checkout the install instructions [here]. | ||
|
|
||
| [here]: https://awsm.readthedocs.io/en/latest/installation.html | ||
|
|
||
| ### Docker | ||
|
|
||
| Docker images are containers that allow us to ship the software to our users | ||
| seamlessly and without a headache. It is by far the easiest way to use AWSM. If | ||
| you are curious to read more about them, visit [Whats a container] on docker's | ||
| website. | ||
|
|
||
| [Whats a container]: https://www.docker.com/what-container | ||
|
|
||
| Using docker images comes with very minor quirks though, such as requiring you to | ||
| mount a volume to access the data when you are done with your run. To mount a | ||
| data volume, so that you can share data between the local file system and the | ||
| docker, the `-v` option must be used. For a more in depth discussion and | ||
| tutorial, read about [docker volumes]. The container has a shared data volume | ||
| at `/data` where the container can access the local file system. | ||
|
|
||
| [docker volumes]: https://docs.docker.com/storage/volumes/ | ||
|
|
||
|
|
||
| **NOTE: On the host paths to the volume to mount, you must use full absolute paths!** | ||
|
|
||
| ### Running the Demo | ||
|
|
||
| To simply run the AWSM demo; mount the desired directory as a volume and run | ||
| the image, using the following command: | ||
|
|
||
| **For Linux:** | ||
|
|
||
| ``` | ||
| docker run -v <path>:/data -it usdaarsnwrc/awsm:develop | ||
| ``` | ||
|
|
||
| **For MacOSX:** | ||
|
|
||
| ``` | ||
| docker run -v /Users/<path>:/data -it usdaarsnwrc/awsm:develop | ||
| ``` | ||
|
|
||
| **For Windows:** | ||
|
|
||
| ``` | ||
| docker run -v /c/Users/<path>:/data -it usdaarsnwrc/awsm:develop | ||
| ``` | ||
|
|
||
| The output netCDF files will be placed in the location you mounted (using the | ||
| -v option). We like to use [ncview] to view our netcdf files quickly. | ||
|
|
||
| [ncview]: http://meteora.ucsd.edu/~pierce/ncview_home_page.html | ||
|
|
||
| ### Setting Up Your Run | ||
|
|
||
| To use the AWSM docker image to create your own runs, you need to setup a | ||
| project folder containing all the files necessary to run the model. Then using | ||
| the same command above, mount your project folder and provide a path to the | ||
| configuration file. An example of a project folder might like: | ||
|
|
||
| ``` | ||
| My_Basin | ||
| ├── air_temp.csv | ||
| ├── cloud_factor.csv | ||
| ├── config.ini | ||
| ├── maxus.nc | ||
| ├── metadata.csv | ||
| ├── output | ||
| ├── precip.csv | ||
| ├── solar.csv | ||
| ├── topo.nc | ||
| ├── vapor_pressure.csv | ||
| ├── wind_direction.csv | ||
| └── wind_speed.csv | ||
| ``` | ||
|
|
||
| Then the command would be: | ||
|
|
||
| ``` | ||
| docker run -v <path>/My_Basin:/data -it usdaarsnwrc/awsm:develop <path>/My_Basin/config.ini | ||
| ``` | ||
| The original repo README [can be found here](README_awsm.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| # Automated Water Supply Model | ||
|
|
||
| [](https://badge.fury.io/gh/USDA-ARS-NWRC%2Fawsm) | ||
| [](https://doi.org/10.5281/zenodo.898158) | ||
| [](https://awsm.readthedocs.io) | ||
| [](https://hub.docker.com/r/usdaarsnwrc/awsm/) | ||
| [](https://hub.docker.com/r/usdaarsnwrc/awsm/) | ||
| [](https://coveralls.io/github/USDA-ARS-NWRC/awsm?branch=HEAD) | ||
| [](https://travis-ci.org/USDA-ARS-NWRC/awsm) | ||
|
|
||
|
|
||
| Automated Water Supply Model (AWSM) was developed at the USDA Agricultural | ||
| Research Service (ARS) in Boise, ID. AWSM was designed to streamline the work | ||
| flow used by the ARS to forecast the water supply of multiple water basins. | ||
| AWSM standardizes the steps needed to distribute weather station data with SMRF, | ||
| run an energy and mass balance with iSnobal, and process the results, while | ||
| maintaining the flexibility of each program. | ||
|
|
||
|  | ||
|
|
||
| ## Quick Start | ||
|
|
||
| The fastest way to get up and running with AWSM is to use the docker images that | ||
| are pre-built and can deployed cross platform. | ||
|
|
||
| To build AWSM natively from source checkout the install instructions [here]. | ||
|
|
||
| [here]: https://awsm.readthedocs.io/en/latest/installation.html | ||
|
|
||
| ### Docker | ||
|
|
||
| Docker images are containers that allow us to ship the software to our users | ||
| seamlessly and without a headache. It is by far the easiest way to use AWSM. If | ||
| you are curious to read more about them, visit [Whats a container] on docker's | ||
| website. | ||
|
|
||
| [Whats a container]: https://www.docker.com/what-container | ||
|
|
||
| Using docker images comes with very minor quirks though, such as requiring you to | ||
| mount a volume to access the data when you are done with your run. To mount a | ||
| data volume, so that you can share data between the local file system and the | ||
| docker, the `-v` option must be used. For a more in depth discussion and | ||
| tutorial, read about [docker volumes]. The container has a shared data volume | ||
| at `/data` where the container can access the local file system. | ||
|
|
||
| [docker volumes]: https://docs.docker.com/storage/volumes/ | ||
|
|
||
|
|
||
| **NOTE: On the host paths to the volume to mount, you must use full absolute paths!** | ||
|
|
||
| ### Running the Demo | ||
|
|
||
| To simply run the AWSM demo; mount the desired directory as a volume and run | ||
| the image, using the following command: | ||
|
|
||
| **For Linux:** | ||
|
|
||
| ``` | ||
| docker run -v <path>:/data -it usdaarsnwrc/awsm:develop | ||
| ``` | ||
|
|
||
| **For MacOSX:** | ||
|
|
||
| ``` | ||
| docker run -v /Users/<path>:/data -it usdaarsnwrc/awsm:develop | ||
| ``` | ||
|
|
||
| **For Windows:** | ||
|
|
||
| ``` | ||
| docker run -v /c/Users/<path>:/data -it usdaarsnwrc/awsm:develop | ||
| ``` | ||
|
|
||
| The output netCDF files will be placed in the location you mounted (using the | ||
| -v option). We like to use [ncview] to view our netcdf files quickly. | ||
|
|
||
| [ncview]: http://meteora.ucsd.edu/~pierce/ncview_home_page.html | ||
|
|
||
| ### Setting Up Your Run | ||
|
|
||
| To use the AWSM docker image to create your own runs, you need to setup a | ||
| project folder containing all the files necessary to run the model. Then using | ||
| the same command above, mount your project folder and provide a path to the | ||
| configuration file. An example of a project folder might like: | ||
|
|
||
| ``` | ||
| My_Basin | ||
| ├── air_temp.csv | ||
| ├── cloud_factor.csv | ||
| ├── config.ini | ||
| ├── maxus.nc | ||
| ├── metadata.csv | ||
| ├── output | ||
| ├── precip.csv | ||
| ├── solar.csv | ||
| ├── topo.nc | ||
| ├── vapor_pressure.csv | ||
| ├── wind_direction.csv | ||
| └── wind_speed.csv | ||
| ``` | ||
|
|
||
| Then the command would be: | ||
|
|
||
| ``` | ||
| docker run -v <path>/My_Basin:/data -it usdaarsnwrc/awsm:develop <path>/My_Basin/config.ini | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters