Metadata-Version: 2.1
Name: vivarium
Version: 3.2.0
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: layered-config-tree >=2.1.0
Requires-Dist: numpy <2.0.0
Requires-Dist: pandas
Requires-Dist: pyyaml >=5.1
Requires-Dist: scipy
Requires-Dist: click
Requires-Dist: tables
Requires-Dist: networkx
Requires-Dist: loguru
Requires-Dist: pyarrow
Requires-Dist: dill
Requires-Dist: pandas-stubs
Requires-Dist: networkx-stubs
Requires-Dist: types-PyYAML
Provides-Extra: dev
Requires-Dist: sphinx <8.0.0,>=4.0 ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme >=0.6 ; extra == 'dev'
Requires-Dist: sphinx-click ; extra == 'dev'
Requires-Dist: IPython ; extra == 'dev'
Requires-Dist: matplotlib ; extra == 'dev'
Requires-Dist: sphinxcontrib-video ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: vivarium-testing-utils ; extra == 'dev'
Requires-Dist: black ==22.3.0 ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: ipywidgets ; extra == 'dev'
Requires-Dist: jupyter ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx <8.0.0,>=4.0 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme >=0.6 ; extra == 'docs'
Requires-Dist: sphinx-click ; extra == 'docs'
Requires-Dist: IPython ; extra == 'docs'
Requires-Dist: matplotlib ; extra == 'docs'
Requires-Dist: sphinxcontrib-video ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
Provides-Extra: interactive
Requires-Dist: IPython ; extra == 'interactive'
Requires-Dist: ipywidgets ; extra == 'interactive'
Requires-Dist: jupyter ; extra == 'interactive'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-mock ; extra == 'test'
Requires-Dist: vivarium-testing-utils ; extra == 'test'

========
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.8-3.11 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.11``

  ``> 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/>`_
-------------------------------------------------------------------
