Metadata-Version: 2.4
Name: vivarium
Version: 4.1.3
Summary: vivarium is a microsimulation framework built on top of the standard scientific python stack.
Home-page: https://github.com/ihmeuw/vivarium
Author: The vivarium developers
Author-email: 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 :: GNU General Public License v3 or later (GPLv3+)
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
License-File: LICENSE.txt
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: layered_config_tree
Requires-Dist: dill
Provides-Extra: docs
Requires-Dist: vivarium_dependencies[ipython,matplotlib,sphinx,sphinx-click]; extra == "docs"
Requires-Dist: sphinxcontrib-video; extra == "docs"
Provides-Extra: test
Requires-Dist: vivarium_dependencies[pytest]; extra == "test"
Requires-Dist: vivarium_testing_utils; extra == "test"
Provides-Extra: interactive
Requires-Dist: vivarium_dependencies[interactive]; extra == "interactive"
Provides-Extra: dev
Requires-Dist: vivarium_dependencies[ipython,matplotlib,sphinx,sphinx-click]; extra == "dev"
Requires-Dist: sphinxcontrib-video; extra == "dev"
Requires-Dist: vivarium_dependencies[pytest]; extra == "dev"
Requires-Dist: vivarium_testing_utils; extra == "dev"
Requires-Dist: vivarium_dependencies[lint]; extra == "dev"
Requires-Dist: mypy<1.17.0; extra == "dev"
Requires-Dist: vivarium_dependencies[interactive]; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

========
Vivarium
========

.. image:: https://badge.fury.io/py/vivarium.svg
    :target: https://badge.fury.io/py/vivarium

.. image:: https://github.com/ihmeuw/vivarium/actions/workflows/build.yml/badge.svg?branch=main
    :target: https://github.com/ihmeuw/vivarium
    :alt: Latest Version

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

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

Vivarium is a simulation framework written using standard scientific Python
tools.

**Vivarium requires Python 3.10-3.12 to run**

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

  ``> pip install vivarium``

or build it from source with

  ``> git clone https://github.com/ihmeuw/vivarium.git``

  ``> cd vivarium``

  ``> conda create -n ENVIRONMENT_NAME python=3.12``

  ``> pip install -e .[dev]``

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

  ``> simulate test``


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