diff --git a/.travis.yml b/.travis.yml index fe54d43e7b..5f3fbe7c99 100644 --- a/.travis.yml +++ b/.travis.yml @@ -27,3 +27,13 @@ after_success: notifications: email: false + +deploy: + provider: pypi + distribution: sdist + user: jgostick + password: + secure: SInoWqd5ayXQAXWr4tbXJNIaNl8Im0vOTGWNiLLlaQZYL/RZCQ5NqUyoi87lIJyjiKApMExOm/RwKKe/bHoSRHLXX/6U0u+4otSC6ZyeAJAhEXqohNmJhGUHhADlqYAhg2vlfjh7CxwNSObvr0SdlTUA5l5ivcofBXiYfxk3i/o= + on: + tags: true + branch: master diff --git a/OpenPNM/__init__.py b/OpenPNM/__init__.py index 9ba4875ee8..e75834a7b1 100644 --- a/OpenPNM/__init__.py +++ b/OpenPNM/__init__.py @@ -33,6 +33,19 @@ ------ >>> import OpenPNM +Example +------- +The following few lines setup all the necessary objects for performing +simulations: + +>>> import OpenPNM as op +>>> net = op.Network.Cubic(shape=[5, 5, 5], spacing=0.001) +>>> geo = op.Geometry.Stick_and_Ball(network=net, pores=net.Ps, throats=net.Ts) +>>> air = op.Phases.Air(network=net) +>>> water = op.Phases.Water(network=net) +>>> phys_air = op.Physics.Standard(network=net, geometry=geo, phase=air) +>>> phys_wat = op.Physics.Standard(network=net, geometry=geo, phase=water) + """ import sys as _sys import scipy as _sp @@ -41,10 +54,7 @@ if _sys.version_info < (3, 4): raise Exception('OpenPNM requires Python 3.4 or greater to run') -if _sp.__version__ < '0.14.0': - raise Exception('OpenPNM requires SciPy version 0.14.0 or greater') - -__version__ = '1.5' +__version__ = '1.6.1' from . import Base from . import Network