
<!-- README.md is generated from README.Rmd. Please edit that file -->

# TUFLOWR

<!-- badges: start -->

[![R-CMD-check](https://github.com/matt-s-gibbs/TUFLOWR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/matt-s-gibbs/TUFLOWR/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

TUFLOWR provides some helper functions for working with [TUFLOW
FV](https://www.tuflow.com/products/tuflow-fv/) models in R. Current
functionality includes generating spatially interpolated initial
conditions based on point observations and the model mesh, as well as
loading POINTS files into the R environment and plotting with ggplot.

## Installation

You can install the released version of TUFLOWR from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("TUFLOWR")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("matt-s-gibbs/TUFLOWR")
```
