openpnm


Nameopenpnm JSON
Version 2.4.2 PyPI version JSON
download
home_pagehttp://openpnm.org
SummaryA framework for conducting pore network modeling simulations of multiphase transport in porous materials
upload_time2020-07-14 16:06:41
maintainer
docs_urlNone
authorOpenPNM Team
requires_python>= 3.6
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![](https://github.com/PMEAL/OpenPNM/workflows/Ubuntu/badge.svg)](https://github.com/PMEAL/OpenPNM/actions)
[![](https://github.com/PMEAL/OpenPNM/workflows/macOS/badge.svg)](https://github.com/PMEAL/OpenPNM/actions)
[![](https://github.com/PMEAL/OpenPNM/workflows/Windows/badge.svg)](https://github.com/PMEAL/OpenPNM/actions)
[![](https://github.com/PMEAL/OpenPNM/workflows/Examples/badge.svg)](https://github.com/PMEAL/OpenPNM/actions)<br/>
[![](https://codecov.io/gh/PMEAL/OpenPNM/branch/master/graph/badge.svg)](https://codecov.io/gh/PMEAL/OpenPNM)
[![](https://img.shields.io/badge/ReadTheDocs-GO-blue.svg)](http://openpnm.readthedocs.io/en/master/)
[![](https://badge.fury.io/py/openpnm.svg)](https://pypi.python.org/pypi/openpnm)
[![](https://anaconda.org/conda-forge/openpnm/badges/installer/conda.svg)](https://anaconda.org/conda-forge/openpnm)


-----

**Please cite as:**
> _Gostick et al._ "**OpenPNM: a pore network modeling package.**" Computing in Science & Engineering 18, no. 4 (2016): 60-74.
> [doi:10.1109/MCSE.2016.49](https://ieeexplore.ieee.org/document/7478437)

# Overview of OpenPNM

*OpenPNM* is a comprehensive framework for performing pore network simulations of porous materials.

For more details about the package can be found in the [on-line documentation](https://openpnm.readthedocs.io/en/master/index.html)

## Installation and Requirements

OpenPNM can be installed from the [Python Package Index](https://pypi.org/project/openpnm/) using:

```
pip install openpnm
```

or from [Anaconda Cloud](https://anaconda.org/conda-forge/openpnm) using:

```
conda install -c conda-forge openpnm
```

or the source code can be downloaded from [Github](https://github.com/pmeal/OpenPNM/) and installed by running:

```
pip install -e 'path/to/downloaded/files'
```

The advantage to installing from the source code is that you can edit the files and have access to your changes each time you import *OpenPNM*.

OpenPNM requires the *Scipy Stack* (Numpy, Scipy, Matplotlib, etc), which is most conveniently obtained by installing the [Anaconda Distribution](https://conda.io/docs/user-guide/install/download.html).

## Example Usage

The following code block illustrates how to use OpenPNM to perform a mercury intrusion porosimetry simulation:

``` python

import openpnm as op
pn = op.network.Cubic(shape=[10, 10, 10], spacing=0.0001)
geo = op.geometry.StickAndBall(network=pn, pores=pn.Ps, throats=pn.Ts)
Hg = op.phases.Mercury(network=pn)
phys = op.physics.Standard(network=pn, phase=Hg, geometry=geo)
mip = op.algorithms.Porosimetry(network=pn)
mip.setup(phase=Hg)
mip.set_inlets(pores=pn.pores(['left', 'right', 'top', 'bottom']))
mip.run()

```

The network can be visualized in [`ParaView`](http://www.paraview.org) giving the following:

<p align="center">
  <img src="https://user-images.githubusercontent.com/14086031/77927983-dc3dd000-7275-11ea-8700-c96c2d51aa1f.png" width="60%"></img>
</p>

The drainage curve can be visualized with `mip.plot_intrusion_curve()` giving something like this:

<p align="center">
  <img src="https://user-images.githubusercontent.com/14086031/77930201-96363b80-7278-11ea-95fd-4a55fb1d6148.png" width="60%"></img>
</p>

A collection of examples is available in the *examples* folder of this repository: [Examples](https://www.github.com/PMEAL/OpenPNM/tree/master/examples)

## Contact

OpenPNM is developed by the Porous Materials Engineering and Analysis Lab [(PMEAL)](http://pmeal.com), in the [Department of Chemical Engineering](https://uwaterloo.ca/chemical-engineering/) at the [University of Waterloo](https://uwaterloo.ca/) in Waterloo, Ontario, Canada.

The lead developer for this project is Prof. Jeff Gostick (jgostick@gmail.com).



            

Raw data

            {
    "_id": null,
    "home_page": "http://openpnm.org",
    "name": "openpnm",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">= 3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "OpenPNM Team",
    "author_email": "jgostick@uwaterloo.ca",
    "download_url": "https://files.pythonhosted.org/packages/03/ab/683f6448ae390a4bb770099f12df8d59c330b8727826f3420e4aeb574209/openpnm-2.4.2.tar.gz",
    "platform": "",
    "description": "[![](https://github.com/PMEAL/OpenPNM/workflows/Ubuntu/badge.svg)](https://github.com/PMEAL/OpenPNM/actions)\n[![](https://github.com/PMEAL/OpenPNM/workflows/macOS/badge.svg)](https://github.com/PMEAL/OpenPNM/actions)\n[![](https://github.com/PMEAL/OpenPNM/workflows/Windows/badge.svg)](https://github.com/PMEAL/OpenPNM/actions)\n[![](https://github.com/PMEAL/OpenPNM/workflows/Examples/badge.svg)](https://github.com/PMEAL/OpenPNM/actions)<br/>\n[![](https://codecov.io/gh/PMEAL/OpenPNM/branch/master/graph/badge.svg)](https://codecov.io/gh/PMEAL/OpenPNM)\n[![](https://img.shields.io/badge/ReadTheDocs-GO-blue.svg)](http://openpnm.readthedocs.io/en/master/)\n[![](https://badge.fury.io/py/openpnm.svg)](https://pypi.python.org/pypi/openpnm)\n[![](https://anaconda.org/conda-forge/openpnm/badges/installer/conda.svg)](https://anaconda.org/conda-forge/openpnm)\n\n\n-----\n\n**Please cite as:**\n> _Gostick et al._ \"**OpenPNM: a pore network modeling package.**\" Computing in Science & Engineering 18, no. 4 (2016): 60-74.\n> [doi:10.1109/MCSE.2016.49](https://ieeexplore.ieee.org/document/7478437)\n\n# Overview of OpenPNM\n\n*OpenPNM* is a comprehensive framework for performing pore network simulations of porous materials.\n\nFor more details about the package can be found in the [on-line documentation](https://openpnm.readthedocs.io/en/master/index.html)\n\n## Installation and Requirements\n\nOpenPNM can be installed from the [Python Package Index](https://pypi.org/project/openpnm/) using:\n\n```\npip install openpnm\n```\n\nor from [Anaconda Cloud](https://anaconda.org/conda-forge/openpnm) using:\n\n```\nconda install -c conda-forge openpnm\n```\n\nor the source code can be downloaded from [Github](https://github.com/pmeal/OpenPNM/) and installed by running:\n\n```\npip install -e 'path/to/downloaded/files'\n```\n\nThe advantage to installing from the source code is that you can edit the files and have access to your changes each time you import *OpenPNM*.\n\nOpenPNM requires the *Scipy Stack* (Numpy, Scipy, Matplotlib, etc), which is most conveniently obtained by installing the [Anaconda Distribution](https://conda.io/docs/user-guide/install/download.html).\n\n## Example Usage\n\nThe following code block illustrates how to use OpenPNM to perform a mercury intrusion porosimetry simulation:\n\n``` python\n\nimport openpnm as op\npn = op.network.Cubic(shape=[10, 10, 10], spacing=0.0001)\ngeo = op.geometry.StickAndBall(network=pn, pores=pn.Ps, throats=pn.Ts)\nHg = op.phases.Mercury(network=pn)\nphys = op.physics.Standard(network=pn, phase=Hg, geometry=geo)\nmip = op.algorithms.Porosimetry(network=pn)\nmip.setup(phase=Hg)\nmip.set_inlets(pores=pn.pores(['left', 'right', 'top', 'bottom']))\nmip.run()\n\n```\n\nThe network can be visualized in [`ParaView`](http://www.paraview.org) giving the following:\n\n<p align=\"center\">\n  <img src=\"https://user-images.githubusercontent.com/14086031/77927983-dc3dd000-7275-11ea-8700-c96c2d51aa1f.png\" width=\"60%\"></img>\n</p>\n\nThe drainage curve can be visualized with `mip.plot_intrusion_curve()` giving something like this:\n\n<p align=\"center\">\n  <img src=\"https://user-images.githubusercontent.com/14086031/77930201-96363b80-7278-11ea-95fd-4a55fb1d6148.png\" width=\"60%\"></img>\n</p>\n\nA collection of examples is available in the *examples* folder of this repository: [Examples](https://www.github.com/PMEAL/OpenPNM/tree/master/examples)\n\n## Contact\n\nOpenPNM is developed by the Porous Materials Engineering and Analysis Lab [(PMEAL)](http://pmeal.com), in the [Department of Chemical Engineering](https://uwaterloo.ca/chemical-engineering/) at the [University of Waterloo](https://uwaterloo.ca/) in Waterloo, Ontario, Canada.\n\nThe lead developer for this project is Prof. Jeff Gostick (jgostick@gmail.com).\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A framework for conducting pore network modeling simulations of multiphase transport in porous materials",
    "version": "2.4.2",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "683e96d74f2c5fea445bc0743ad8394a",
                "sha256": "8092388c5413d0bd5a005e4ec44bb7020c63755282c9d83e79f7b64c1dc53a90"
            },
            "downloads": -1,
            "filename": "openpnm-2.4.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "683e96d74f2c5fea445bc0743ad8394a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">= 3.6",
            "size": 377163,
            "upload_time": "2020-07-14T16:06:40",
            "upload_time_iso_8601": "2020-07-14T16:06:40.746150Z",
            "url": "https://files.pythonhosted.org/packages/ab/08/9aad0611adf3b58d8ce5cc3f5346f972d286044f10f41b0e49a91c21a903/openpnm-2.4.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "7dc636e455c79b4ec1b12ff3eba6ee81",
                "sha256": "dd72d614727462a72a7fd82776f370156b6da8566471725216ae16ac66f7c990"
            },
            "downloads": -1,
            "filename": "openpnm-2.4.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7dc636e455c79b4ec1b12ff3eba6ee81",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">= 3.6",
            "size": 274741,
            "upload_time": "2020-07-14T16:06:41",
            "upload_time_iso_8601": "2020-07-14T16:06:41.994492Z",
            "url": "https://files.pythonhosted.org/packages/03/ab/683f6448ae390a4bb770099f12df8d59c330b8727826f3420e4aeb574209/openpnm-2.4.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-07-14 16:06:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "openpnm"
}
        
Elapsed time: 0.15065s