Metadata-Version: 2.4
Name: vivarium-engine
Version: 5.0.0
Summary: vivarium is a microsimulation framework built on top of the standard scientific python stack.
Author-email: The vivarium developers <vivarium.dev@gmail.com>
License: BSD-3-Clause
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Life
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: vivarium-artifact
Requires-Dist: vivarium-config-tree
Requires-Dist: vivarium-dependencies[click,loguru,networkx,numpy_lt_2,pandas,pyarrow,pyyaml,scipy,tables]
Requires-Dist: vivarium-build-utils<4.0.0,>=3.0.2
Requires-Dist: dill
Provides-Extra: interactive
Requires-Dist: vivarium-dependencies[interactive]; extra == "interactive"
Provides-Extra: test
Requires-Dist: vivarium-dependencies[pytest]; extra == "test"
Requires-Dist: vivarium-testing-utils; extra == "test"
Provides-Extra: docs
Requires-Dist: vivarium-dependencies[ipython,matplotlib,sphinx,sphinx-click]; extra == "docs"
Requires-Dist: sphinxcontrib-video; extra == "docs"
Provides-Extra: lint
Requires-Dist: vivarium-dependencies[lint]; extra == "lint"
Requires-Dist: mypy<1.17.0; extra == "lint"
Provides-Extra: dev
Requires-Dist: vivarium-engine[docs,interactive,lint,test]; extra == "dev"
Provides-Extra: cluster
Provides-Extra: ci-github
Requires-Dist: vivarium-engine[docs,lint,test]; extra == "ci-github"
Provides-Extra: ci-jenkins
Requires-Dist: vivarium-engine[ci_github,cluster]; extra == "ci-jenkins"
Dynamic: license-file

===============
vivarium.engine
===============

.. image:: https://readthedocs.org/projects/vivarium-engine/badge/?version=latest
    :target: https://vivarium-engine.readthedocs.io/en/latest/?badge=latest
    :alt: Latest Docs

.. image:: https://zenodo.org/badge/96817805.svg
   :target: https://zenodo.org/badge/latestdoi/96817805

``vivarium-engine`` is a simulation framework written using standard scientific
Python tools.

Installation
------------

**Supported Python versions: 3.10, 3.11, 3.12, 3.13**

.. note::

    If you have an older version of ``vivarium`` installed, you should uninstall
    it before installing ``vivarium-engine``. If you have both packages installed,
    you may see deprecation warnings when importing from ``vivarium`` and it's possible
    that some imports will break if they hit the old package's on-disk location
    instead of the new one.

You can install ``vivarium-engine`` from PyPI with pip:

.. code-block:: bash

   pip install vivarium-engine

or build it from source with

.. code-block:: bash

   git clone https://github.com/ihmeuw/vivarium-suite.git
   cd vivarium-suite
   pip install libs/engine


This will make the ``vivarium-engine`` library available to python and install a
command-line executable called ``simulate`` that you can use to verify your
installation with

.. code-block:: bash

   simulate test

For broader monorepo development setup, see the monorepo README at
https://github.com/ihmeuw/vivarium-suite.

`Check out the docs! <https://vivarium-engine.readthedocs.io/en/latest/>`_
--------------------------------------------------------------------------
