Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thurber authored Oct 17, 2022
1 parent 2a2cb77 commit fbd7bf0
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ status](https://travis-ci.com/IMMM-SFA/starfit.svg?branch=master)](https://travi
<!-- badges: end -->

`starfit` is a package that is designed to work with reservoir time
series data in [USRDATS]() to infer operating storage targets and
series data in ResOpsUS ([dataset](https://doi.org/10.5281/zenodo.5367382); [paper](https://www.nature.com/articles/s41597-022-01134-7)) to infer operating storage targets and
release functions.

## Installation
Expand All @@ -23,13 +23,13 @@ devtools::install_github("IMMM-SFA/starfit")

#### Example - fit storage targets for Garrison Dam, North Dakota.

This example assumes that you have downloaded [USRDATS](). First, we’ll
This example assumes that you have downloaded the [ResOpsUS dataset](https://doi.org/10.5281/zenodo.5367382). First, we’ll
use the `fit_targets()` function to infer parameters of weekly storage
targets for this dam (which is GRanD ID 753).

``` r
library(starfit)
fit_targets(your_path_to_USRDATS, dam_id = 753) -> fitted_targets
fit_targets(your_path_to_ResOpsUS, dam_id = 753) -> fitted_targets
#> ℹ Fitting targets for dam 753: Garrison Dam

# take a look at the output:
Expand Down

0 comments on commit fbd7bf0

Please sign in to comment.