Skip to content

Commit c6e4ea2

Browse files
Update data format documentation
1 parent 53d79bd commit c6e4ea2

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

docs/src/expected_data_formats.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,28 @@ By convention, Streamfall expects data to be formatted in the following manner:
77
- Unit of measure itself is optionally included in square brackets (`[]`)
88
- In-file comments are indicated with a hash (`#`)
99

10+
## Streamflow data
1011

11-
## Example
12+
Data for a node representing a subcatchment or gauge should, at a minimum, include columns
13+
for date and streamflow (`Q`) in a consistent unit (in this case, megaliters/day).
14+
15+
Streamflow columns should begin with its name and include an identifiable suffix.
16+
Here, `_Q` is used but this can be user-defined when preparing data for modelling.
17+
18+
```csv
19+
# A comment
20+
Date,406219_Q_[ML]
21+
1988-07-23,0.5184
22+
1988-07-24,13.6512
23+
1988-07-25,407.6352
24+
1988-07-26,2488.4928
25+
1988-07-27,3443.6448
26+
... snip ...
27+
```
28+
29+
## Dam releases
30+
31+
Note that releases is denoted with `_releases`.
1232

1333
```csv
1434
# A comment
@@ -21,7 +41,6 @@ Date, 406000_releases_[ML], 406000_extractions_[ML]
2141
... snip ...
2242
```
2343

24-
2544
## Climate data
2645

2746
Streamfall currently expects data for all nodes to be stored in one large DataFrame.
@@ -30,7 +49,7 @@ Streamfall currently expects data for all nodes to be stored in one large DataFr
3049
### Example climate data structure
3150

3251
```csv
33-
Date, 406214_rain, 406214_evap, 406219_rain, 406219_evap
52+
Date, 406214_P, 406214_ET, 406219_P, 406219_ET
3453
1981-01-01, 0.0, 4.8, 0.0, 4.9
3554
1981-01-02, 0.1, 0.5, 0.1, 3.3
3655
1981-01-03, 10.5, 5.3, 7.2, 2.3
@@ -39,6 +58,8 @@ Date, 406214_rain, 406214_evap, 406219_rain, 406219_evap
3958
... snip ...
4059
```
4160

61+
where `P` indicates rainfall, and `ET` denotes evapotranspiration.
62+
4263
### Climate data functions
4364

4465
```@autodocs

0 commit comments

Comments
 (0)