Skip to content

Commit

Permalink
Added missing results directory
Browse files Browse the repository at this point in the history
  • Loading branch information
qjhart committed Apr 28, 2016
1 parent 8eca895 commit 01f3f10
Show file tree
Hide file tree
Showing 6 changed files with 131 additions and 0 deletions.
62 changes: 62 additions & 0 deletions results/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Results (Model)

This is a template for how the results of each modeling effort should be organized, the idea being that each model can be reviewed in the same manner. Use the README.md file to give a brief overview of the model, and the results supplied. If you are including data not specified in the standard dataset, please describe the differences.

If you have multiple results, please follow this same format, but use different base directories; prefixed with ```results```, for example, the prescriptive _ET_ calculation method may include _results_cdl/_ and _results_nasa/_ directories to describe results from two different landcover maps.

Note, that you are required to supply the files: ```wy2015/monthly.csv``` and
the raster ```wy2015/monthly/ET.tif```.


## Daily (and Monthly) Parameters

Throughout the results the following parameter names should be used. The values
in () specify the units for the parameters. For monthly or yearly summaries, the values should still be scaled to the daily estimates. For example, the monthly _ET_ for June should be represented as the average daily value.

- _ET_ (mm/day) Evapotranspiration. This is the actual/estimated values. Daily, monthly, and yearly estimates can be supplied, but should be scaled to a per day estimate.

- _ETo_ (mm/day) Reference Evapotranspiration--Short Grass. This is the ASCE reference value for short grass.

- _ETr_ (mm/day) Reference Evapotranspiration--Alfalfa. This is the ASCE reference value for alfalfa.

- _Kc_ (unitless) Crop coefficient, defined as _ET_/_ETo_.

- _Kcr_ (unitless) Crop coefficient (alfalfa) defined as _ET_/_ETr_.

- _Ts_ (C) Surface Temperature. This is the modeled value of the actual
surface. For

- _H_ (Wh/m^2) Sensible Heat Flux. This is the measured/modeled value. This is the daily value. For instantaneous values use _iH_ (W/m^2).

- _G_ (Wh/m^2 ) Soil Heat Flux. For instantaneous values use _iG_ (W/m^2).

- _lc_dwr_ or _lc_cdl_ (categorical) DWR Land Cover Crop types. You can either specify what landcover map you are using of those supplied, eg.
- [ssj-landcover-nasa](https://github.com/ssj-delta-cu/ssj-nasa-landcover/)
- [ssj-overview](https://github.com/ssj-delta-cu/ssj-overview/)

or specify a landcover map yourself. If you specify your own, you must use either the Cropland Data Layer identifiers, or the DWR Landcover classes.

## Instantaneous values

Some satellite based products will want to report some of these values as their instantaneous value, for comparison. Typically we use a _i_ prefix on the values. They usually have different units as well. The time the instantaneous value is measured needs to be referenced.

- _iET_ (mm/hr)
- _iETo_ (mm/hr)
- _iETr_ (mm/day)
- _iTs_ (C) For a satellite overpass, this is the instantaneous temperature.
- _iH_ (W/m^2)
- _iG_ (W/m^2 )
- _iRn_ (W/m^2)

## Raster Data Products

Hi-resolution images can be supplied in a projection consistent with the underlying landsat data product. They should be supplied in EPSG:26910, with the lower left coordinate (ll)=```596898, 4162595``` and upper right coordinate (ur)=```656748```, 4276385``` at 30 (m) resolution. This results in images that are of size ```1995,3793```.

Images should be named for the parameter they represent. Multiple bands for an image will always be different times, not different parameters. You should supply the data as floating point values for each pixel.

Please *do not* supply complete landsat images in you results, only for the region described above.


## Weather Parameters

Additional weather specific parameters have been defined in the the [ssj-weather](https://github.com/ssj-delta-cu/ssj-weather) project. Please use the same naming scheme there. Please note the difference in Radiation, defined in units (MJ/m^2) as opposed to some of the other defined energy fluxes, (Wh/m^2) ```1MJ=277.778 Wh```. This is to maintain consistency with results from the Spatial CIMIS application.
31 changes: 31 additions & 0 deletions results/wy2015/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Water Year 2015

This directory is meant to supply and overall average _ET_ for the complete Water Year 2015 (2014-10-01 thru 2015-09-30).

# Rasters

You may supply ```ET.tif``` showing the average daily _ET_ for the Delta Service area for the entire year.

# CSV files

You must supply a table of the monthly ET (```monthly.csv```) over a set of regions for the Delta Service Area. The regions must include: dsa,islands,points,crops?


## CSV formats

For the ```monthly.csv``` file, the format is shown below. The date is the first date of the month for which the estimate is made.

```
date,region,ET,(ETo,Kc,....)
2014-10-01,dsa,5.1,...
2014-11-01,dsa,4.3,....
```


The ```daily.csv``` follows the same format, with the date showing the actual date for the estimates.

```
date,region,ET,(ETo,Kc,....)
2014-10-01,dsa,5.40
2014-10-02,dsa,5.43
```
13 changes: 13 additions & 0 deletions results/wy2015/daily/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Daily Water Year 2015

This directory should hold rasters for each day of the water year.

# Rasters

You should supply ```ET.tif``` showing the daily _ET_ for the Delta Service area for the entire year. This should have 365 bands, and the first band should correspond to the first day of the water year 2014-10-01.

Supplying any of the additional parameters, _Kc_, _H_, _G_, would be very helpful. Again supply these as 365 band files.

# CSV files

Any CSV files should be stored in the above directory.
3 changes: 3 additions & 0 deletions results/wy2015/dates/2014285/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Instantaneous Hi-Resolution data products

Here is where you locate your instantaneous data products. For example, if you are using landsat imagery to determine instantaneous _ET_ for a particular overpass, this is where you store those data. We expect most of the data here to be GeoTIFF files, and had the naming parameters as described in the [results README](../../../README.md).
9 changes: 9 additions & 0 deletions results/wy2015/dates/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Instantaneous Data products

Supplying instantaneous data products, like landsat estimated _ET_ values is very helpful for comparison. These should be stored in this directory. There are no required data products for this, but we encourage users to include as many intermediate products as can help comparisons.

Following the lead of some of the landsat products, we suggest that you organize your data by concatenating the year and the julian day. For example, ```2014285`` is the first landsat overpass in the 2015 water year.

## CSV Files.

You can summarize your individual dates into csv files similar to those described in the above results directory.
13 changes: 13 additions & 0 deletions results/wy2015/monthly/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Monthly Water Year 2015

This directory should hold rasters for the monthly datasets

# Rasters

You must supply ```ET.tif``` showing the average daily _ET_ for the Delta Service area for the entire year. This should have 12 bands, and the first band should correspond to the first month of the water year, 2014-10.

Supplying any of the additional parameters, _Kc_, _H_, _G_, would be very helpful. Again supply these as 12 band files.

# CSV files

Any CSV files should be stored in the above directory.

0 comments on commit 01f3f10

Please sign in to comment.