Metadata-Version: 1.1
Name: otfmi
Version: 0.1
Summary: Simulate FMUs from OpenTURNS.
Home-page: None
Author: Sylvain Girard
Author-email: girard@phimeca.com
License: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Description: .. image:: https://travis-ci.org/openturns/otfmi.svg?branch=master
            :target: https://travis-ci.org/openturns/otfmi
        
        .. image:: https://ci.appveyor.com/api/projects/status/kqk2wuce65pcl3rh/branch/master?svg=true
            :target: https://ci.appveyor.com/project/openturns/otfmi
        
        
        This is the source tree or distribution for the otfmi package for simulating
        functional mockup units (FMUs) from OpenTURNS.
        
        The functional mock-up interface (FMI) standard specifies a format for
        multipurpose, easy to build and reusable data interfaces to numerical models.
        A functional mock-up unit (FMU) is a black box defined by the FMI standard,
        akin to the wrappers familiar to the OpenTURNS’ community.
        
        The purpose of the otfmi Python module is to promote the use of the
        probabilistic approach with system models, in particular those written in
        Modelica, by enabling easy manipulation of FMUs with OpenTURNS. The otfmi
        module relies on one PyFMI, a module for manipulating FMUs within Python.
        
        
        Installation
        ============
        
        The otfmi module relies on PyFMI. It can be installed using the distutils
        mechanism (setupe.py) or the windows installer. Alternatively, it can be used
        without installation by adding the package directory ('otfmi') to the
        PYTHONPATH.
        
        
        Installation of PyFMI
        ---------------------
        The otfmi module relies on PyFMI [PYFMI]_.
        On windows, PyFMI can be installed using an installer program is available.
        
        Otherwise, relying on Anaconda [ANACONDA]_ is recommended. Indeed, compiling
        PyFMI from sources and sorting out its dependencies can be troublesome. With
        Python installed from Anaconda, PyFMI is installed by the following command:
        
            conda install -c https://conda.binstar.org/chria pyfmi
        
        Usage without installation
        ---------------------------
        The module can be imported in a Python session as soon as
        the otfmi folder is listed in the PYTHONPATH environment variable. If you installed Python
        using Anaconda, the otfmi folder can be placed in any directory “monitored” by Anaconda,
        for instance C:\\Users\\username\\Anaconda\\lib\\site-packages on Windows.
        
        Installation of otfmi
        ---------------------
        The otfmi module can be installed from sources using the
        classical distutils procedure. From the main folder, run the following command:
        
            python setup.py install
        
        On windows, it is possible to avoid resorting to command line interface by using the
        installer program otfmi-X.X.win32.exe ( X.X is the version number).
        
        Removal of otfmi
        ----------------
        Removing otfmi if you installed it from the command line is just
        a matter of removing all created files. Usually, it is a single file, otfmi-X.X-py2.7.egg
        (X.X is the version number) located in the default directory for external module. The
        path to this directory depends on your Python installation. On Windows with Anaconda, it
        is C:\\Users\\username\\Anaconda\\lib\\site-packages.
        The list of all created file can be retrieved by the following command
        
            python setup.py install --record list_file.txt
        
        Documentation
        =============
        
        See the “User documentation” [USERDOC]_ for more usage instruction.
        
        See the “Project documentation” [PROJECTDOC]_ for information about the module architecture.
        
        Example scripts are given in the 'example' folder in the source tree.
        
        License
        =======
        
        This package is licensed under the LGPL3.
        
        References
        ==========
        .. [PYFMI] PyFMI Python module. url: http://www.jmodelica.org/page/4924
        .. [ANACONDA] Anaconda, Python distribution. url: http://continuum.io/downloads
        .. [USERDOC] Girard, Sylvain (2017). otfmi: simulate FMUs from OpenTURNS: User documentation. Tech. rep. RT-PMFRE-00997-003. Phimeca.
        .. [PROJECTDOC] Girard, Sylvain (2017). otfmi: simulate FMUs from OpenTURNS: Project documentation. Tech. rep. RT-PMFRE-00997-002. Phimeca.
        
Keywords: functional mockup interface (FMI)
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
