| Name | swatmf JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | |
| Summary | swatmf is a set of python modules for SWAT-MODFLOW model evaluation and parameter estimation. |
| upload_time | 2023-07-26 19:46:38 |
| maintainer | |
| docs_url | None |
| author | Seonggyu Park |
| requires_python | |
| license | |
| keywords |
python
swat-modflow
pest
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
======
swatmf
======
.. image:: https://img.shields.io/pypi/v/swatmf?color=blue
:target: https://pypi.python.org/pypi/swatmf
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/l/swatmf
:target: https://opensource.org/licenses/BSD-3-Clause
:alt: PyPI - License
.. image:: https://zenodo.org/badge/304147230.svg
:target: https://zenodo.org/badge/latestdoi/304147230
`swatmf` is a set of python modules for SWAT-MODFLOW model (Bailey et al., 2016) parameter estimation and uncertainty analysis with the open-source suite PEST (Doherty 2010a and 2010b, and Doherty and other, 2010).
===========================================
Uncertainty Analysis for SWAT-MODFLOW model
===========================================
Get data and jupyter notebooks
------------------------------
You essentially have 2 options:
Easy way
--------
- `Download the data zip file <https://github.com/spark-brc/swatmf/archive/refs/heads/main.zip>`_
- Unzip `swatmf-main.zip` to a prefered location.
Hard way (Dev mode)
-------------------
- You will need to install Git if you don’t have it installed already. Downloads are available at [the link](https://git-scm.com/download). On windows, be sure to select the option that installs command-line tools
- For Git, you will need to set up SSH keys to work with Github. To do so:
- Go to GitHub.com and set up an account
- On Windows, open Git Bash (on Mac/Linux, just open a terminal) and set up ssh keys if you haven’t already. To do this, simply type ssh-keygen in git bash/terminal and accept all defaults (important note - when prompted for an optional passphrase, just hit return.)
- Follow the `instructions <https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/>`_ to set up the SSH keys with your GitHub account.
- Clone the materials from GitHub.
- Open a git bash shell from the start menu (or, on a Mac/Linux, open a terminal)
- Navigate to the folder you made to put the course materials
- Clone the materials by executing the following in the git bash or terminal window:
.. code-block:: bash
git clone https://github.com/spark-brc/swatmf.git
============
Installation
============
To execute jupyter notebook, we need the Miniconda environment.
1. Miniconda Python:
--------------------
- If you don't already have conda installed, please download Miniconda for your operating system from https://conda.io/en/latest/miniconda.html (choose the latest version for your operating system, 64-bit). You should not need elevated rights to install this.
- Run the installer and select "only my user" when prompted. This will allow you to work with your python installation directly.
2. Set Environment and install libraries:
-----------------------------------------
- After installation, go to the START menu and select "Miniconda Prompt" to open a DOS box.
- Type the following command:
.. code-block:: bash
conda install -c conda-forge mamba
- Using the `cd <https://www.computerhope.com/issues/chusedos.htm>`_ command in the Miniconda DOS box, navigate to the location where you have `environment.yml` the file and type:
.. code-block:: bash
mamba env create -f environment.yml
and hit ENTER.
After your virtual environment setup is complete, change the environment to `swatmf`:
.. code-block:: bash
conda activate swatmf
- Launch jupyter notebook
.. code-block:: bash
jupyter notebook
A browser window with a Jupyter notebook instance should open. Yay!
.. rubric:: Brief overview of the API
.. code-block:: python
from swatmf import swatmf_pst_utils
>>> wd = "User-SWAT-MODFLOW working directory"
>>> swat_wd = "User-SWAT working directory"
>>> swatmf_pst_utils.init_setup(wd, swat_wd)
Creating 'backup' folder ... passed
Creating 'echo' folder ... passed
Creating 'sufi2.in' folder ... passed
'beopest64.exe' file copied ... passed
'i64pest.exe' file copied ... passed
'i64pwtadj1.exe' file copied ... passed
'forward_run.py' file copied ... passed
Raw data
{
"_id": null,
"home_page": "",
"name": "swatmf",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,SWAT-MODFLOW,PEST",
"author": "Seonggyu Park",
"author_email": "<envpsg@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/73/4e/249d1f7933bbeadea716e195957131f49a204036686161b55fb07e65213f/swatmf-0.3.0.tar.gz",
"platform": null,
"description": "======\r\nswatmf\r\n======\r\n\r\n.. image:: https://img.shields.io/pypi/v/swatmf?color=blue\r\n :target: https://pypi.python.org/pypi/swatmf\r\n :alt: PyPI Version\r\n.. image:: https://img.shields.io/pypi/l/swatmf\r\n :target: https://opensource.org/licenses/BSD-3-Clause\r\n :alt: PyPI - License\r\n.. image:: https://zenodo.org/badge/304147230.svg\r\n :target: https://zenodo.org/badge/latestdoi/304147230\r\n\r\n\r\n\r\n`swatmf` is a set of python modules for SWAT-MODFLOW model (Bailey et al., 2016) parameter estimation and uncertainty analysis with the open-source suite PEST (Doherty 2010a and 2010b, and Doherty and other, 2010).\r\n\r\n===========================================\r\nUncertainty Analysis for SWAT-MODFLOW model\r\n===========================================\r\n\r\n\r\nGet data and jupyter notebooks\r\n------------------------------\r\n\r\nYou essentially have 2 options:\r\n\r\nEasy way\r\n--------\r\n\r\n- `Download the data zip file <https://github.com/spark-brc/swatmf/archive/refs/heads/main.zip>`_\r\n- Unzip `swatmf-main.zip` to a prefered location.\r\n\r\n\r\nHard way (Dev mode)\r\n-------------------\r\n\r\n- You will need to install Git if you don\u00e2\u20ac\u2122t have it installed already. Downloads are available at [the link](https://git-scm.com/download). On windows, be sure to select the option that installs command-line tools \r\n- For Git, you will need to set up SSH keys to work with Github. To do so:\r\n - Go to GitHub.com and set up an account\r\n - On Windows, open Git Bash (on Mac/Linux, just open a terminal) and set up ssh keys if you haven\u00e2\u20ac\u2122t already. To do this, simply type ssh-keygen in git bash/terminal and accept all defaults (important note - when prompted for an optional passphrase, just hit return.) \r\n- Follow the `instructions <https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/>`_ to set up the SSH keys with your GitHub account.\r\n- Clone the materials from GitHub.\r\n - Open a git bash shell from the start menu (or, on a Mac/Linux, open a terminal)\r\n - Navigate to the folder you made to put the course materials\r\n - Clone the materials by executing the following in the git bash or terminal window:\r\n\r\n\r\n.. code-block:: bash\r\n\r\n git clone https://github.com/spark-brc/swatmf.git\r\n\r\n\r\n============\r\nInstallation\r\n============\r\n\r\nTo execute jupyter notebook, we need the Miniconda environment.\r\n\r\n1. Miniconda Python:\r\n--------------------\r\n\r\n- If you don't already have conda installed, please download Miniconda for your operating system from https://conda.io/en/latest/miniconda.html (choose the latest version for your operating system, 64-bit). You should not need elevated rights to install this.\r\n- Run the installer and select \"only my user\" when prompted. This will allow you to work with your python installation directly.\r\n\r\n2. Set Environment and install libraries:\r\n-----------------------------------------\r\n\r\n- After installation, go to the START menu and select \"Miniconda Prompt\" to open a DOS box.\r\n- Type the following command:\r\n\r\n\r\n\r\n.. code-block:: bash\r\n\r\n conda install -c conda-forge mamba\r\n\r\n\r\n- Using the `cd <https://www.computerhope.com/issues/chusedos.htm>`_ command in the Miniconda DOS box, navigate to the location where you have `environment.yml` the file and type: \r\n\r\n.. code-block:: bash\r\n\r\n mamba env create -f environment.yml\r\n\r\nand hit ENTER.\r\n\r\nAfter your virtual environment setup is complete, change the environment to `swatmf`: \r\n\r\n.. code-block:: bash\r\n\r\n conda activate swatmf\r\n\r\n- Launch jupyter notebook \r\n\r\n.. code-block:: bash\r\n\r\n jupyter notebook\r\n\r\n\r\nA browser window with a Jupyter notebook instance should open. Yay!\r\n\r\n\r\n\r\n\r\n.. rubric:: Brief overview of the API\r\n\r\n.. code-block:: python\r\n\r\n from swatmf import swatmf_pst_utils\r\n\r\n >>> wd = \"User-SWAT-MODFLOW working directory\"\r\n >>> swat_wd = \"User-SWAT working directory\"\r\n >>> swatmf_pst_utils.init_setup(wd, swat_wd)\r\n\r\n Creating 'backup' folder ... passed\r\n Creating 'echo' folder ... passed\r\n Creating 'sufi2.in' folder ... passed\r\n 'beopest64.exe' file copied ... passed\r\n 'i64pest.exe' file copied ... passed\r\n 'i64pwtadj1.exe' file copied ... passed\r\n 'forward_run.py' file copied ... passed\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "swatmf is a set of python modules for SWAT-MODFLOW model evaluation and parameter estimation.",
"version": "0.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/spark-brc/swatmf/issues",
"Documentation": "https://github.com/spark-brc/swatmf",
"Download": "https://pypi.org/project/swatmf",
"Source Code": "https://github.com/spark-brc/swatmf"
},
"split_keywords": [
"python",
"swat-modflow",
"pest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7153d3435b497a16b4510882183e63658df7489139e4be926a1bca5c2474b193",
"md5": "d44053f7e5322b79cc3fe1dd7361b0ce",
"sha256": "9f08fc97859e992d19fd139c68b93243d1037a1f7a9559c5538469d43a0243ea"
},
"downloads": -1,
"filename": "swatmf-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d44053f7e5322b79cc3fe1dd7361b0ce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8270352,
"upload_time": "2023-07-26T19:46:36",
"upload_time_iso_8601": "2023-07-26T19:46:36.006755Z",
"url": "https://files.pythonhosted.org/packages/71/53/d3435b497a16b4510882183e63658df7489139e4be926a1bca5c2474b193/swatmf-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "734e249d1f7933bbeadea716e195957131f49a204036686161b55fb07e65213f",
"md5": "cbd3118ff0c0e8181a4ad3954172cabf",
"sha256": "270d09910834e1975242875f601483a68bd0c63680638d98be545ede6c1ec492"
},
"downloads": -1,
"filename": "swatmf-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "cbd3118ff0c0e8181a4ad3954172cabf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5992060,
"upload_time": "2023-07-26T19:46:38",
"upload_time_iso_8601": "2023-07-26T19:46:38.512716Z",
"url": "https://files.pythonhosted.org/packages/73/4e/249d1f7933bbeadea716e195957131f49a204036686161b55fb07e65213f/swatmf-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-26 19:46:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spark-brc",
"github_project": "swatmf",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "swatmf"
}
