Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 3.03 KB

README.md

File metadata and controls

45 lines (32 loc) · 3.03 KB
Raw

ISOMSIMpy

ISOSIMpy (c) by the ISOSIMpy Team is a package for the application of lumped parameter models (LPM) to simulate groundwater age dynamics on the basis of tracer and isotope measurements. This package is primarily used for teaching and a first introduction to the field of LPM mdoelling in isotope groundwater hydrology. For applications in research, please contact the development team (see below).

ISOSIMpy is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

You should have received a copy of the license along with this work. If not, see http://creativecommons.org/licenses/by-nc-sa/4.0/.

Please note:

This code is still under development. None of the components have been finally tested.

If you have any questions, write an email to max_gustav.rudolph@tu-dresden.de

MyBinder

Binder

A Binder is available in which you can run the example notebooks remotely. With that, you do not need to install a Python distribution but you are also limited in functionality and adaptability.

Installing and Using the Package

If you have experience with the Python programming language, just download the source code from this repository and move the ISOSIMpy package files (Pre.py, Calculate.py, Multis.py, Post.py, main.py) to a local directory from which you intend to work. Proceed with using the package as demonstrated in the examples / Jupyter Notebooks.

If you do not have experience with the Python programming language, please perform the following steps:

  1. Download the source code in this repository
    1. here, click on the green button labeled Code and select download zip
    2. after downloading, unpack the zip-archive into a target directory (name it, e.g., ISOSIMpy)
  2. Download Anaconda (most popular and easy-to-use Python distribution) here
  3. Install Anaconda
    1. during the installation DO NOT SET THE PATH VARIABLE and DO NOT SET AS DEFAULT PYTHON INSTALLATION
  4. Open the Anaconda PowerShell Prompt
    1. press your [WINDOWS] button
    2. in the menu, locate the folder named Anaconda (or similar)
    3. open Anaconda PowerShell Prompt
  5. Install a required package
    1. (still in the PowerShell Prompt) type conda install -c conda-forge ipyfilechooser and hit [ENTER]; if asked, type y and hit [ENTER] to proceed
  6. Open JupyterLab
    1. (still in the PowerShell Prompt) type jupyter lab and hit [ENTER]; now a new tab with JupyterLab should open in your browser
    2. Note: JupyterLab may not work with the Microsoft Edge browser; use Chrome or Firefox instead (set Chrome or Firefox as default browser)
  7. Open an available Jupyter Notebook
    1. in the file manager of JupyterLab, navigate to the ISOSIMpy directory and open an available Jupyter Notebook (e.g., Notebook_Tracer_simple.ipynb)