openpnm 1.0.0__zip

OpenPNM-1.1/OpenPNM/__init__.py

@@ -0,0 +1,56 @@
+r"""
+##################################################################################
+:mod:`OpenPNM` --  A scientific pore network simulator for porous media transport
+##################################################################################
+
+Documentation is available in the docstrings and in the on-line documentation.
+
+
+Subpackages
+-----------
+
+.. list-table:: OpenPNM Submodule structure.
+   :widths: 10 80
+   :header-rows: 1
+
+   * - Name
+     - Description
+   * - :mod:`OpenPNM.Network`
+     - Storage and manipulations of network topoologies and data stored on them.
+   * - :mod:`OpenPNM.Geometry`
+     - Geometry for pore networks. (Random cubic, image based, Voronoi). Should also contain
+       a mapper of the pore network back on the segmented image.
+   * - :mod:`OpenPNM.Physics`
+     - Module containing pore scale physics models and equations.
+   * - :mod:`OpenPNM.Phases`
+     - Module containing thremophyics property estimation models.
+   * - :mod:`OpenPNM.Algorithms`
+     - Module containing all algorithmic classes for networks.
+   * - :mod:`OpenPNM.Utilities`
+     - common utilities and classes used by most of the of the modules
+
+Import
+------
+>>> import OpenPNM
+
+"""
+
+import scipy as sp
+
+if sp.__version__ < '0.14.0':
+	raise Exception('OpenPNM requires SciPy version 0.14.0 or greater')
+
+__version__ = '1.1-beta'
+
+__requires__ = ['scipy']
+
+from . import Base
+from . import Utilities
+from . import Network
+from . import Geometry
+from . import Phases
+from . import Physics
+from . import Algorithms
+from . import Postprocessing
+
+

OpenPNM-1.1/OpenPNM.egg-info/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 1.1
+Name: OpenPNM
+Version: 1.1
+Summary: A framework for conducting pore network modeling simulations of multiphase transport in porous materials.
+Home-page: https://github.com/pmeal/OpenPNM
+Author: OpenPNM Team
+Author-email: jeff.gostick@mcgill.ca
+License: UNKNOWN
+Download-URL: https://github.com/pmeal/OpenPNM/
+Description: UNKNOWN
+Platform: UNKNOWN

OpenPNM-1.1/OpenPNM.egg-info/SOURCES.txt

@@ -0,0 +1,107 @@
+MANIFEST.in
+README.txt
+setup.cfg
+setup.py
+OpenPNM/__init__.py
+OpenPNM.egg-info/PKG-INFO
+OpenPNM.egg-info/SOURCES.txt
+OpenPNM.egg-info/dependency_links.txt
+OpenPNM.egg-info/requires.txt
+OpenPNM.egg-info/top_level.txt
+OpenPNM/Algorithms/__FickianDiffusion__.py
+OpenPNM/Algorithms/__FourierConduction__.py
+OpenPNM/Algorithms/__GenericAlgorithm__.py
+OpenPNM/Algorithms/__GenericLinearTransport__.py
+OpenPNM/Algorithms/__InvasionPercolationForImbibition__.py
+OpenPNM/Algorithms/__InvasionPercolationTimed__.py
+OpenPNM/Algorithms/__InvasionPercolation__.py
+OpenPNM/Algorithms/__OhmicConduction__.py
+OpenPNM/Algorithms/__OrdinaryPercolation__.py
+OpenPNM/Algorithms/__StokesFlow__.py
+OpenPNM/Algorithms/__Tortuosity__.py
+OpenPNM/Algorithms/__init__.py
+OpenPNM/Base/__Controller__.py
+OpenPNM/Base/__Core__.py
+OpenPNM/Base/__ModelsDict__.py
+OpenPNM/Base/__Tools__.py
+OpenPNM/Base/__init__.py
+OpenPNM/Geometry/__Boundary__.py
+OpenPNM/Geometry/__Cube_and_Cuboid__.py
+OpenPNM/Geometry/__GenericGeometry__.py
+OpenPNM/Geometry/__SGL10__.py
+OpenPNM/Geometry/__Stick_and_Ball__.py
+OpenPNM/Geometry/__TestGeometry__.py
+OpenPNM/Geometry/__Toray090__.py
+OpenPNM/Geometry/__Voronoi__.py
+OpenPNM/Geometry/__init__.py
+OpenPNM/Geometry/models/__init__.py
+OpenPNM/Geometry/models/pore_area.py
+OpenPNM/Geometry/models/pore_centroid.py
+OpenPNM/Geometry/models/pore_diameter.py
+OpenPNM/Geometry/models/pore_misc.py
+OpenPNM/Geometry/models/pore_seed.py
+OpenPNM/Geometry/models/pore_surface_area.py
+OpenPNM/Geometry/models/pore_vertices.py
+OpenPNM/Geometry/models/pore_volume.py
+OpenPNM/Geometry/models/throat_area.py
+OpenPNM/Geometry/models/throat_centroid.py
+OpenPNM/Geometry/models/throat_diameter.py
+OpenPNM/Geometry/models/throat_length.py
+OpenPNM/Geometry/models/throat_misc.py
+OpenPNM/Geometry/models/throat_normal.py
+OpenPNM/Geometry/models/throat_offset_vertices.py
+OpenPNM/Geometry/models/throat_perimeter.py
+OpenPNM/Geometry/models/throat_seed.py
+OpenPNM/Geometry/models/throat_shape_factor.py
+OpenPNM/Geometry/models/throat_surface_area.py
+OpenPNM/Geometry/models/throat_vector.py
+OpenPNM/Geometry/models/throat_vertices.py
+OpenPNM/Geometry/models/throat_volume.py
+OpenPNM/Network/__Cubic__.py
+OpenPNM/Network/__DelaunayCubic__.py
+OpenPNM/Network/__Delaunay__.py
+OpenPNM/Network/__GenericNetwork__.py
+OpenPNM/Network/__MatFile__.py
+OpenPNM/Network/__TestNet__.py
+OpenPNM/Network/__init__.py
+OpenPNM/Network/models/__init__.py
+OpenPNM/Network/models/pore_topology.py
+OpenPNM/Phases/__Air__.py
+OpenPNM/Phases/__GenericPhase__.py
+OpenPNM/Phases/__Mercury__.py
+OpenPNM/Phases/__TestPhase__.py
+OpenPNM/Phases/__Water__.py
+OpenPNM/Phases/__init__.py
+OpenPNM/Phases/models/__init__.py
+OpenPNM/Phases/models/contact_angle.py
+OpenPNM/Phases/models/density.py
+OpenPNM/Phases/models/diffusivity.py
+OpenPNM/Phases/models/electrical_conductivity.py
+OpenPNM/Phases/models/misc.py
+OpenPNM/Phases/models/molar_density.py
+OpenPNM/Phases/models/molar_mass.py
+OpenPNM/Phases/models/surface_tension.py
+OpenPNM/Phases/models/thermal_conductivity.py
+OpenPNM/Phases/models/vapor_pressure.py
+OpenPNM/Phases/models/viscosity.py
+OpenPNM/Physics/__GenericPhysics__.py
+OpenPNM/Physics/__Standard__.py
+OpenPNM/Physics/__TestPhysics__.py
+OpenPNM/Physics/__init__.py
+OpenPNM/Physics/models/__init__.py
+OpenPNM/Physics/models/capillary_pressure.py
+OpenPNM/Physics/models/diffusive_conductance.py
+OpenPNM/Physics/models/electrical_conductance.py
+OpenPNM/Physics/models/generic_source_term.py
+OpenPNM/Physics/models/hydraulic_conductance.py
+OpenPNM/Physics/models/multiphase.py
+OpenPNM/Physics/models/thermal_conductance.py
+OpenPNM/Postprocessing/Graphics.py
+OpenPNM/Postprocessing/Plots.py
+OpenPNM/Postprocessing/__init__.py
+OpenPNM/Utilities/IO.py
+OpenPNM/Utilities/Shortcuts.py
+OpenPNM/Utilities/__init__.py
+OpenPNM/Utilities/misc.py
+OpenPNM/Utilities/transformations.py
+OpenPNM/Utilities/vertexops.py

OpenPNM-1.1/OpenPNM.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

OpenPNM-1.1/OpenPNM.egg-info/requires.txt

@@ -0,0 +1 @@
+scipy>=0.14.0

OpenPNM-1.1/OpenPNM.egg-info/top_level.txt

@@ -0,0 +1 @@
+OpenPNM

OpenPNM-1.1/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 1.1
+Name: OpenPNM
+Version: 1.1
+Summary: A framework for conducting pore network modeling simulations of multiphase transport in porous materials.
+Home-page: https://github.com/pmeal/OpenPNM
+Author: OpenPNM Team
+Author-email: jeff.gostick@mcgill.ca
+License: UNKNOWN
+Download-URL: https://github.com/pmeal/OpenPNM/
+Description: UNKNOWN
+Platform: UNKNOWN

OpenPNM-1.1/README.txt

@@ -0,0 +1,88 @@
+OpenPNM
+=======
+
+.. contents::
+
+What is OpenPNM?
+--------------
+
+OpenPNM is open-source framework for conducting pore network modeling 
+simulations of multiphase transport in porous materials.  It includes 
+modules for generating various common network topologies, pore and 
+throat geometry models, pore scale physics models, and fluid property
+estimation.  It also contains a large set of algorithms for running various
+simulations such drainage curves, gas diffusion, permeability, and more.  
+
+OpenPNM is written in Python making extensive use of Scipy. Python is a very
+flexible object oriented programming language that will be familiar to those
+with experience using Matlab.  OpenPNM takes advantages of the OOP paradigm
+to structure the framework, but we stress that it is coded by engineers 
+without significant prior knowledge of object-oriented coding.  Our goal
+is to help other scientists and engineers harness the power and intuitive
+pore network modeling approach, so if you are interested in this package, 
+please contact us through Github, or email one of the developer directly.
+
+
+Installation
+------------
+
+.. code-block:: python
+
+    pip install openpnm
+
+
+Documentation
+-------------
+
+OpenPNM documentation is available on the web:
+
+    http://openpnm.org
+
+
+Web sites
+---------
+
+The user's site is:
+
+    http://openpnm.org
+
+
+Mailing Lists
+-------------
+
+Please see the developer's discussion on GitHub:
+
+    https://github.com/PMEAL/OpenPNM/issues
+
+
+Latest source code
+------------------
+
+The latest development version of OpenPNM sources are always available at:
+
+    https://github.com/PMEAL/OpenPNM
+
+They can be downloaded as a zip file or using the Git client.
+
+
+Bug reports
+-----------
+
+To search for bugs or report them, please use the OpenPNM Bug Tracker at:
+
+    https://github.com/PMEAL/OpenPNM/issues
+
+
+Developer information
+---------------------
+
+If you would like to take part in OpenPNM development, please join the discussion on Github.
+We are a small group and can guide you directly.
+
+
+License information
+-------------------
+
+See the file ``LICENSE.txt`` for information on the history of this
+software, terms & conditions for usage, and a DISCLAIMER OF ALL
+WARRANTIES.

OpenPNM-1.1/setup.cfg

@@ -0,0 +1,7 @@
+[easy_install]
+
+[egg_info]
+tag_svn_revision = 0
+tag_build = 
+tag_date = 0
+

OpenPNM-1.1/setup.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+
+import os
+import sys
+sys.path.append(os.getcwd())
+
+import scipy as sp
+
+if sp.__version__ < '0.14.0':
+	raise Exception('OpenPNM requires SciPy version 0.14.0 or greater')
+
+try:
+    from setuptools import setup
+except ImportError:
+    from distutils.core import setup
+
+setup(
+    name='OpenPNM',
+    packages=['OpenPNM',
+              'OpenPNM.Base',
+              'OpenPNM.Network',
+              'OpenPNM.Network.models',
+              'OpenPNM.Geometry',
+              'OpenPNM.Geometry.models',
+              'OpenPNM.Phases',
+              'OpenPNM.Phases.models',
+              'OpenPNM.Physics',
+              'OpenPNM.Physics.models',
+              'OpenPNM.Utilities',
+              'OpenPNM.Algorithms',
+              'OpenPNM.Postprocessing'],
+    version='1.1',
+    description="A framework for conducting pore network modeling simulations of multiphase transport in porous materials.",
+    author='OpenPNM Team',
+    author_email='jeff.gostick@mcgill.ca',
+    download_url='https://github.com/pmeal/OpenPNM/',
+    url='https://github.com/pmeal/OpenPNM',
+	install_requires = ['scipy>=0.14.0'],
+)