Metadata-Version: 2.1
Name: FiPy
Version: 3.2
Summary: A finite volume PDE solver in Python
Home-page: http://www.ctcms.nist.gov/fipy/
Author: Jonathan Guyer, Daniel Wheeler, & Jim Warren
Author-email: fipy@nist.gov
License: 
        ------------
        Terms of Use
        ------------        
        This software was developed by employees of the `National Institute of
        Standards and Technology`_ (NIST_), an agency of the Federal Government and
        is being made available as a public service.  Pursuant to `title 17 United
        States Code Section 105`_, works of NIST_ employees are not subject to
        copyright protection in the United States.  This software may be subject to
        foreign copyright.  Permission in the United States and in foreign
        countries, to the extent that NIST_ may hold copyright, to use, copy,
        modify, create derivative works, and distribute this software and its
        documentation without fee is hereby granted on a non-exclusive basis,
        provided that this notice and disclaimer of warranty appears in all copies.        
        THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
        EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY
        WARRANTY THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED
        WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
        FREEDOM FROM INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL
        CONFORM TO THE SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR
        FREE. IN NO EVENT SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT
        LIMITED TO, DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT
        OF, RESULTING FROM, OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR
        NOT BASED UPON WARRANTY, CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT
        INJURY WAS SUSTAINED BY PERSONS OR PROPERTY OR OTHERWISE, AND WHETHER OR
        NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT OF THE RESULTS OF, OR USE OF, THE
        SOFTWARE OR SERVICES PROVIDED HEREUNDER.        
        .. _National Institute of Standards and Technology: http://www.nist.gov/
        .. _NIST: http://www.nist.gov/
        .. _title 17 United States Code Section 105: https://www.copyright.gov/title17/92chap1.html#105
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib

Description: 
        ========
        Overview
        ========
        
        | |CircleCI|_ |TravisCI|_ |AppVeyor|_
        | |GitHub|_ |PyPi|_  |Codacy|_ |CondaForge|_ |Binder|_
        | |gitter|_ |Depsy|_ |OpenHub|_
        
        .. only:: latex
        
           :term:`FiPy` is an object oriented, partial differential equation (PDE)
           solver, written in :term:`Python`, based on a standard finite volume
           (FV) approach. The framework has been developed in the Materials Science
           and Engineering Division (MSED_) and Center for Theoretical and
           Computational Materials Science (CTCMS_), in the Material Measurement
           Laboratory (MML_) at the National Institute of Standards and Technology
           (NIST_).
        
           The solution of coupled sets of PDEs is ubiquitous to the numerical
           simulation of science problems.  Numerous PDE solvers exist, using a
           variety of languages and numerical approaches. Many are proprietary,
           expensive and difficult to customize.  As a result, scientists spend
           considerable resources repeatedly developing limited tools for
           specific problems.  Our approach, combining the FV method and :term:`Python`,
           provides a tool that is extensible, powerful and freely available. A
           significant advantage to :term:`Python` is the existing suite of tools for
           array calculations, sparse matrices and data rendering.
        
        The :term:`FiPy` framework includes terms for transient diffusion,
        convection and standard sources, enabling the solution of arbitrary
        combinations of coupled elliptic, hyperbolic and parabolic PDEs. Currently
        implemented models include phase field :cite:`BoettingerReview:2002`
        :cite:`ChenReview:2002` :cite:`McFaddenReview:2002` treatments of polycrystalline,
        dendritic, and electrochemical phase transformations, as well as drug
        eluting stents :cite:`Saylor:2011p2794`, reactive wetting :cite:`PhysRevE.82.051601`,
        photovoltaics :cite:`Hangarter:2011p2795` and a level set treatment of the
        electrodeposition process :cite:`NIST:damascene:2001`.
        
        .. only:: latex
        
           The latest information about :term:`FiPy` can be found at
           http://www.ctcms.nist.gov/fipy/.
        
           See the latest updates in the :ref:`CHANGELOG`.
        
        ---------------------------------
        Even if you don't read manuals...
        ---------------------------------
        
        ...please read :ref:`INSTALLATION`, :ref:`USAGE` and :ref:`FAQ`, as well
        as :mod:`examples.diffusion.mesh1D`.
        
        -------------------------
        Download and Installation
        -------------------------
        
        Please refer to :ref:`INSTALLATION` for details on download and
        installation. :term:`FiPy` can be redistributed and/or modified
        freely, provided that any derivative works bear some notice that they
        are derived from it, and any modified versions bear some notice that
        they have been modified.
        
        -------
        Support
        -------
        
        You can communicate with the :term:`FiPy` developers and with other
        users via our `mailing list`_ and we welcome you to use the `issue
        tracker`_ for bugs, support requests, feature requests and patch
        submissions <https://github.com/usnistgov/fipy/issues>. We also monitor
        StackOverflow_ for questions tagged with "fipy". We welcome
        collaborative efforts on this project.
        
        .. toctree::
        
           documentation/MAIL
        
        ------------------------
        Conventions and Notation
        ------------------------
        
        :term:`FiPy` is driven by :term:`Python` script files than you can view or modify in any
        text editor.  :term:`FiPy` sessions are invoked from a command-line shell, such
        as :command:`tcsh` or :command:`bash`.
        
        Throughout, text to be typed at the keyboard will appear ``like this``.
        Commands to be issued from an interactive shell will appear::
        
            $ like this
        
        where you would enter the text ("``like this``") following the shell prompt,
        denoted by "``$``".
        
        Text blocks of the form::
        
            >>> a = 3 * 4
            >>> a
            12
            >>> if a == 12:
            ...     print "a is twelve"
            ...
            a is twelve
        
        are intended to indicate an interactive session in the :term:`Python` interpreter.
        We will refer to these as "interactive sessions" or as "doctest blocks".
        The text "``>>>``" at the beginning of a line denotes the *primary prompt*,
        calling for input of a :term:`Python` command.  The text "``...``" denotes the
        *secondary prompt*, which calls for input that continues from the line
        above, when required by :term:`Python` syntax.  All remaining lines, which begin
        at the left margin, denote output from the :term:`Python` interpreter.  In all
        cases, the prompt is supplied by the :term:`Python` interpreter and should not be
        typed by you.
        
        .. warning::
        
           :term:`Python` is sensitive to indentation and care should be taken to enter
           text exactly as it appears in the examples.
        
        When references are made to file system paths, it is assumed that the
        current working directory is the :term:`FiPy` distribution directory, referred to
        as the "base directory", such that::
        
            examples/diffusion/steadyState/mesh1D.py
        
        will correspond to, *e.g.*::
        
            /some/where/FiPy-X.Y/examples/diffusion/steadyState/mesh1D.py
        
        Paths will always be rendered using POSIX conventions (path elements
        separated by "``/``").  Any references of the form::
        
            examples.diffusion.steadyState.mesh1D
        
        are in the :term:`Python` module notation and correspond to the equivalent POSIX
        path given above.
        
        We may at times use a
        
        .. note::
        
           to indicate something that may be of interest
        
        or a
        
        .. warning::
        
           to indicate something that could cause serious problems.
        
        .. _MML:           http://www.nist.gov/mml/
        .. _CTCMS:         http://www.ctcms.nist.gov/
        .. _MSED:          http://www.nist.gov/mml/msed/
        .. _NIST:          http://www.nist.gov/
        .. _issue tracker: https://github.com/usnistgov/fipy/issues
        .. _mailing list:  http://www.ctcms.nist.gov/fipy/documentation/MAIL.html
        .. _StackOverflow: http://stackoverflow.com/questions/tagged/fipy
        
        .. |GitHub|        image:: https://img.shields.io/github/contributors/usnistgov/fipy.svg
        .. _GitHub:        https://github.com/usnistgov/fipy
        .. |gitter|        image:: https://badges.gitter.im/usnistgov/fipy.svg
        .. _gitter:        https://gitter.im/usnistgov/fipy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge
        .. |CircleCI|      image:: https://img.shields.io/circleci/project/github/usnistgov/fipy/develop.svg?label=Linux
        .. _CircleCI:      https://circleci.com/gh/usnistgov/fipy
        .. |TravisCI|      image:: https://img.shields.io/travis/usnistgov/fipy/develop.svg?label=macOS
        .. _TravisCI:      https://travis-ci.org/usnistgov/fipy
        .. |AppVeyor|      image:: https://ci.appveyor.com/api/projects/status/github/usnistgov/fipy?branch=develop&svg=true&failingText=Windows%20-%20failing&passingText=Windows%20-%20passing&pendingText=Windows%20-%20pending
        .. _AppVeyor:      https://ci.appveyor.com/project/guyer/fipy
        .. |OpenHub|       image:: https://www.openhub.net/p/fipy/widgets/project_thin_badge.gif
        .. _OpenHub:       https://www.openhub.net/p/fipy
        .. |PyPi|          image:: https://img.shields.io/pypi/v/fipy.svg
        .. _PyPi:          https://pypi.python.org/pypi/FiPy
        .. |CondaForge|    image:: https://anaconda.org/conda-forge/fipy/badges/installer/conda.svg
        .. _CondaForge:    https://anaconda.org/guyer/fipy
        .. |Depsy|         image:: http://depsy.org/api/package/pypi/FiPy/badge.svg
        .. _Depsy:         http://depsy.org/package/python/FiPy
        .. |Codacy|         image:: https://api.codacy.com/project/badge/Grade/d02921bb54b14e88a1e2e1f5520133f4
        .. _Codacy:         https://www.codacy.com/app/tkphd/fipy?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=usnistgov/fipy&amp;utm_campaign=Badge_Grade
        .. |Binder|        image:: https://mybinder.org/badge.svg
        .. _Binder:        https://mybinder.org/v2/gh/usnistgov/fipy/develop?filepath=examples%2Findex.ipynb
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: Science/Research
Classifier: License :: Public Domain
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
