Installation

Python dependencies

Modflow-obs requires numpy, pandas and the affine library. Additionally, running the demonstration example requires Jupyter Notebooks. The easiest way to install these is using conda.

Instructions for installing Miniforge, a minimal conda-based python distribution, can be found here.

The requirements.yml file included at the top level of this repository includes the necessary packages.

conda env create -f requirements.yml

Installing Modflow-obs using pip

Pip can be used to fetch Modflow-obs directly from GitHub:

pip install git+git://github.com/aleaf/modflow-obs@master

Subsequent updates can then be made with

pip install --upgrade git+git://github.com/aleaf/modflow-obs@master

or by uninstalling and reinstalling. To uninstall:

pip uninstall modflow-obs

Installing the Modflow-obs source code in-place

Alternatively, if you intend to contribute to Modflow-obs (please do!) or update your install frequently, the best route is probably to clone the source code from git and install it in place.

git clone https://github.com/aleaf/modflow-obs.git
cd modflow-obs
pip install -e .

Note

Don’t forget the . after pip install -e!

Your local copy of the Modflow-obs repository can then be subsequently updated with

git pull origin master

Note

If you are making local changes to Modflow-obs that you want to contribute, the workflow is slightly different. See the Contributing to Modflow-obs page for more details.