Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.1%) to scientific vocabulary
Repository
xmipy extension for the MODFLOW API
Basic Info
- Host: GitHub
- Owner: MODFLOW-ORG
- License: cc0-1.0
- Language: Python
- Default Branch: develop
- Homepage: https://modflowapi.readthedocs.io
- Size: 333 KB
Statistics
- Stars: 26
- Watchers: 18
- Forks: 17
- Open Issues: 10
- Releases: 4
Metadata Files
README.md
modflowapi
An extension to xmipy for the MODFLOW API.
Introduction
The modflowapi Python package can be used to access functionality in the eXtended Model Interface (XMI) wrapper (XmiWrapper)
and additional functionality specific to the MODFLOW API. Currently it is a joint development of the USGS and Deltares.
Installation
modflowapi requires Python 3.10+, with:
shell
numpy
pandas
xmipy
To install modflowapi with pip:
pip install modflowapi
Or with conda:
conda install -c conda-forge modflowapi
Documentation
Documentation is available on ReadTheDocs.
Examples using modflowapi and its extensions can be found in the Quickstart and the Extensions notebooks. An example of using the MODFLOW API to monitor heads during a simulation can be found in the Head Monitor Example Notebook.
For more info on MODFLOW 6 see the USGS overview.
Citation
Hughes, Joseph D., Russcher, M. J., Langevin, C. D., Morway, E. D. and McDonald, R. R., 2022, The MODFLOW Application Programming Interface for simulationcontrol and software interoperability: Environmental Modelling & Software, v. 148, p. 105257, doi:10.1016/j.envsoft.2021.105257.
Owner
- Name: MODFLOW and Related Programs
- Login: MODFLOW-ORG
- Kind: organization
- Email: modflow@usgs.gov
- Repositories: 20
- Profile: https://github.com/MODFLOW-ORG
Organization for MODFLOW development
Citation (CITATION.cff)
cff-version: 1.2.0
message: If you use this software, please cite both the article from preferred-citation
and the software itself.
type: software
title: MODFLOW API
version: 0.3.0.dev0
date-released: '2023-04-19'
abstract: An extension to xmipy for the MODFLOW API.
repository-artifact: https://pypi.org/project/modflowapi
repository-code: https://github.com/MODFLOW-ORG/modflowapi
license: CC0-1.0
authors:
- family-names: Hughes
given-names: Joseph D.
alias: jdhughes-usgs
affiliation: U.S. Geological Survey
orcid: https://orcid.org/0000-0003-1311-2354
- family-names: Russcher
given-names: Martijn
alias: mjr-deltares
affiliation: Deltares
orcid: https://orcid.org/0000-0001-8799-6514
- family-names: Langevin
given-names: Christian D.
alias: langevin-usgs
affiliation: U.S. Geological Survey
orcid: https://orcid.org/0000-0001-5610-9759
- family-names: Hofer
given-names: Julian
alias: Hofer-Julian
affiliation: Deltares
- family-names: Larsen
given-names: Joshua D.
alias: jlarsen-usgs
affiliation: U.S. Geological Survey
orcid: https://orcid.org/0000-0002-1218-800X
preferred-citation:
type: article
authors:
- family-names: Hughes
given-names: Joseph D.
orcid: https://orcid.org/0000-0003-1311-2354
- family-names: Russcher
given-names: Martijn J.
orcid: https://orcid.org/0000-0001-8799-6514
- family-names: Langevin
given-names: Christian D.
orcid: https://orcid.org/0000-0001-5610-9759
- family-names: Morway
given-names: Eric D.
orcid: https://orcid.org/0000-0002-8553-6140
- family-names: McDonald
given-names: Richard R.
orcid: https://orcid.org/0000-0002-0703-0638
title: The MODFLOW Application Programming Interface for simulation control and software interoperability
doi: 10.1016/j.envsoft.2021.105257
journal: Environmental Modelling & Software
volume: 138
start: 105257
year: 2022
month: 2
GitHub Events
Total
- Issues event: 8
- Watch event: 2
- Issue comment event: 36
- Push event: 12
- Pull request review event: 1
- Pull request event: 30
- Fork event: 2
Last Year
- Issues event: 8
- Watch event: 2
- Issue comment event: 36
- Push event: 12
- Pull request review event: 1
- Pull request event: 30
- Fork event: 2
Issues and Pull Requests
Last synced: 6 months ago
Dependencies
- appdirs *
- black *
- bmipy *
- coverage *
- flake8 *
- nose *
- nose-timer *
- numpy *
- pylint *
- requests *
- xmipy *
- xmipy *
- actions/checkout v2.3.4 composite
- actions/setup-python v2 composite