Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add vic_sample_data submodule #387

Merged
merged 18 commits into from
Mar 24, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "samples/VIC_sample_data"]
path = samples/VIC_sample_data
url = https://github.com/jhamman/VIC_sample_data
2 changes: 1 addition & 1 deletion docs/Development/ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ This is a major update from VIC 4. The VIC 5.0.0 release aims to have nearly ide

Similarly, output variables `OUT_NET_LONG` and `OUT_NET_SHORT` have been replaced with `OUT_LWNET` and `OUT_SWNET`, respectively.

3. Changed the name of the variable VEGCOVER to FCANOPY, since this more accurately captures the meaning of the term (i.e., the fractional area of the plant canopy within the veg tile). Similarly changed OUT_VEGCOVER to OUT_FCANOPY.
4. Changed the name of the variable VEGCOVER to FCANOPY, since this more accurately captures the meaning of the term (i.e., the fractional area of the plant canopy within the veg tile). Similarly changed OUT_VEGCOVER to OUT_FCANOPY.

Similarly, changed the names of the following global parameter file options:
- VEGLIB_VEGCOVER
Expand Down
28 changes: 28 additions & 0 deletions samples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
VIC Sample Data
===============

This directory includes complete sample datasets to run VIC. Sample datasets that are currently included in the VIC source code repository:

## Image Driver
1. Stehekin - 10-days of forcings

## Classic Driver

1. Stehekin - 10-days of forcings

## Summary of Datasets:
1. Stehekin: This is a distributed datasets that covers the entire Stehekin River Basin, located in Washington State, USA.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

datasets --> dataset

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added a note that more datasets will be added...

2. More will be added soon!

## Getting the Datasets:
The VIC sample datasets are in a "git submodule", to download the datasets to this directory, simply run the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first comma -> period (right?)


```
./get_sample_data.bash
```

You may also download the sample data to another location on your computer by specifying the directory in which you would like to add the data:

```
git clone https://github.com/jhamman/VIC_sample_data.git path/folder_name
```
1 change: 1 addition & 0 deletions samples/VIC_sample_data
Submodule VIC_sample_data added at b7b16c
18 changes: 18 additions & 0 deletions samples/get_sample_data.bash
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#! /usr/bin/env bash

set -e

# save a few directory names
CWD=$PWD
SAMPLES="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where does ${BASH_SOURCE[0]} get set?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the full path of this file. (e.g. /home/VIC/samples/get_sample_data.bash)


git submodule init

# Get the sample data
cd $SAMPLES/VIC_sample_data
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this directory guaranteed to exist already?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes. This is the empty submodule that we're going to fill with the next commands.

git fetch origin
# TODO - get data branch/tag that aligns with the state of the VIC repo.
git checkout master

# back to the original directory
cd $CWD