View Code? Open in Web Editor NEW

Wood River Valley Groundwater-Flow Model

License: Creative Commons Zero v1.0 Universal

R 7.74% TeX 7.44% Fortran 84.74% Makefile 0.08%

wrv's Introduction

wrv

Overview

The R package wrv is for processing the groundwater-flow model of the Wood River Valley (WRV) aquifer system, south-central Idaho. The groundwater-flow model is described in the associated model report and model archive. Included in the package is MODFLOW-USG version 1.3, a U.S. Geological Survey (USGS) computer code that solves the groundwater-flow equation.

Install

You can install wrv from GitHub, and its dependencies from CRAN, using the following commands:

if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_github("USGS-R/wrv", dependencies = TRUE)

Run

Load wrv in the current R session

library(wrv)

Access package documentation

help(package = "wrv")

See training material for example applications using the wrv package.

Contact

Please consider reporting bugs and asking questions on the Issues page.

Disclaimer

This software has been approved for release by the U.S. Geological Survey (USGS). Although the software has been subjected to rigorous review, the USGS reserves the right to update the software as needed pursuant to further analysis and review. No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. Furthermore, the software is released on condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from its authorized or unauthorized use.

NOTICE: upcoming default branch name change

The master branch of this repository will soon be renamed from master to main, as part of a coordinated change across the USGS-R and USGS-VIZLAB organizations. This is part of a broader effort across the git community to use more inclusive language. For instance, git, GitHub, and GitLab have all changed or are in the process of changing their default branch name.

We will make this change early in the week of February 6, 2022. The purpose of this issue is to give notification of the change and provide information on how to make it go smoothly.

When this change is made, forks and clones of the repository will need to be updated as well. Here are instructions for making the necessary changes.

On GitHub, change the default branch name from master to main (<your repository> -> Settings -> Branches).
Change the default branch on any forks you have, as well as local clones. (See details below)
If you have collaborators on this repository, let them know that they will need to change their forked/local repos. Point them to this issue to facilitate the process!
Search within your repository for "master" so that you can change references (e.g. URLs pointing to specific commit points of files) to point to "main" instead.
When you are done, feel free to close this issue!

Changing default branches on forks and local clones

First, update your local git configuration so that new repositories created locally will have the correct default branch: git config --global init.defaultBranch main.

Now, for any forks, do the following:

Go to <your fork> -> Settings -> Branches and edit the default branch from master to main.
Update the settings for your local clone of this fork to match this change.

git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a

Recommend Projects

usgs-r / wrv Goto Github PK

wrv's Introduction

wrv

Overview

Install

Run

Contact

Disclaimer

wrv's People

Contributors

Stargazers

Watchers

Forkers

wrv's Issues

Changing default branches on forks and local clones

Recommend Projects

Recommend Topics

Recommend Org