Metadata-Version: 2.4
Name: vivarium-interactive
Version: 1.0.1
Summary: Run and inspect vivarium simulations interactively, for example in a notebook.
Author-email: The vivarium developers <vivarium.dev@gmail.com>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/ihmeuw/vivarium-suite
Project-URL: Source, https://github.com/ihmeuw/vivarium-suite/tree/main/libs/interactive
Classifier: Intended Audience :: Developers
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 :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: vivarium-engine>=6.0.0
Requires-Dist: vivarium-config-tree
Requires-Dist: vivarium-dependencies[numpy,pandas]
Requires-Dist: vivarium-build-utils<5.0.0,>=4.0.0
Provides-Extra: interactive
Requires-Dist: vivarium-dependencies[interactive]; extra == "interactive"
Provides-Extra: test
Requires-Dist: vivarium-dependencies[ipython,loguru,networkx,pytest,pyyaml]; extra == "test"
Requires-Dist: pytest-vivarium; extra == "test"
Requires-Dist: vivarium-fuzzy-checker; extra == "test"
Provides-Extra: docs
Requires-Dist: vivarium-dependencies[sphinx]; extra == "docs"
Provides-Extra: lint
Requires-Dist: vivarium-dependencies[lint]; extra == "lint"
Provides-Extra: dev
Requires-Dist: vivarium-interactive[docs,interactive,lint,test]; extra == "dev"
Provides-Extra: cluster
Provides-Extra: ci-github
Requires-Dist: vivarium-interactive[docs,lint,test]; extra == "ci-github"
Provides-Extra: ci-jenkins
Requires-Dist: vivarium-interactive[ci_github,cluster]; extra == "ci-jenkins"
Dynamic: license-file

====================
Vivarium Interactive
====================

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

.. image:: https://readthedocs.org/projects/vivarium-interactive/badge/?version=latest
    :target: https://vivarium-interactive.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

This library provides ``Simulation``, a way to run and inspect a vivarium
simulation interactively, for example in a Jupyter notebook. It steps the
simulation on demand and exposes the population, pipelines, resources,
and results for inspection.

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

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

.. code-block:: bash

   pip install vivarium-interactive

or build it from source by cloning the monorepo and installing this package:

.. code-block:: bash

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

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

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