Metadata-Version: 2.1
Name: cis-interface
Version: 0.7.10
Summary: A framework for combining interdependent models from multiple languages.
Home-page: https://github.com/cropsinsilico/cis_interface
Author: Meagan Lang
Author-email: langmm.astro@gmail.com
License: BSD
Download-URL: https://github.com/cropsinsilico/cis_interface/archive/0.7.10.tar.gz
Keywords: plants,simulation,models,framework
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: C
Classifier: Programming Language :: C++
Classifier: Programming Language :: ML
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Development Status :: 3 - Alpha
Requires-Dist: numpy (>=1.13.0)
Requires-Dist: scipy
Requires-Dist: pyyaml
Requires-Dist: pystache
Requires-Dist: pyzmq
Requires-Dist: psutil
Requires-Dist: jsonschema
Requires-Dist: perf
Requires-Dist: sysv-ipc ; platform_system != "Windows"
Requires-Dist: pandas ; python_version != "3.4"
Requires-Dist: matplotlib (<3.0) ; python_version < "3.5"
Requires-Dist: pint ; python_version == "2.7"
Requires-Dist: pandas (<0.21) ; python_version == "3.4"
Requires-Dist: python-rapidjson ; python_version >= "3.4"
Requires-Dist: unyt ; python_version >= "3.4"
Requires-Dist: matplotlib ; python_version >= "3.5"

|PyPI version| |Build Status| |Build status| |Coverage Status| |codecov|
|PEP8|

The CiS framework provides support for combining scientific models
written in different programming languages. To combine two models,
modelers add simple communications interfaces to the model code and
provide simple declarative specification files that identify the models
that should be run and the inputs and outputs those models expect.

The system uses the specification files to configure the communications
channels and expose them to the models. The complexity of the particular
communications system is managed by the framework, which performs
communication setup, binds the communications to simple interfaces
within the models, and manages execution of the models. The complexities
of model registration and discovery, as well as the complexities of
setup and management of the communications system are handled
under-the-hood by the framework under direction of the model
specification, freeing the domain scientist from implementing
communications protocols or translating models to the same programming
language.

Please refer to the package
`documentation <https://cropsinsilico.github.io/cis_interface/>`__ for
additional information about the package and directions for installing
it.

.. warning:: This will be the last release of the Crops in Silico 
   framework under the name ``cis_interface``. Moving forward, 
   the package will be refered to as ``yggdrasil``. The new 
   Github repository for ``yggdrasil`` can be found 
   `here <https://github.com/cropsinsilico/yggdrasil>`__ 
   and the new documentation can be found 
   `here <https://cropsinsilico.github.io/yggdrasil/>`__. 
   Future versions of the ``yggdrasil`` package be installed from 
   PyPI via ``pip install yggdrasil-framework``. We apologize for 
   any inconvenince this change causes, but feel the new name 
   better reflects the spirit of the project.

.. |PyPI version| image:: https://img.shields.io/pypi/v/cis_interface.svg?colorB=g&style=flat
   :target: https://pypi.org/project/cis-interface/
.. |Build Status| image:: https://img.shields.io/travis/cropsinsilico/yggdrasil/cis_interface.svg?style=flat
   :target: https://travis-ci.org/cropsinsilico/yggdrasil
.. |Build status| image:: https://img.shields.io/appveyor/ci/langmm/yggdrasil/cis_interface.svg?style=flat
   :target: https://ci.appveyor.com/project/langmm/yggdrasil/branch/cis_interface
.. |Coverage Status| image:: https://coveralls.io/repos/github/cropsinsilico/yggdrasil/badge.svg?branch=cis_interface
   :target: https://coveralls.io/github/cropsinsilico/yggdrasil?branch=cis_interface
.. |codecov| image:: https://codecov.io/gh/cropsinsilico/yggdrasil/branch/cis_interface/graph/badge.svg
   :target: https://codecov.io/gh/cropsinsilico/yggdrasil
.. |PEP8| image:: https://img.shields.io/badge/code%20style-pep8-orange.svg
   :target: https://www.python.org/dev/peps/pep-0008/


