Metadata-Version: 2.4
Name: risk_distributions
Version: 2.3.5
Summary: Components for building distributions. Compatible for use with ``vivarium``
Home-page: https://github.com/ihmeuw/risk_distributions
Author: The risk_distributions developers
Author-email: vivarium.dev@gmail.com
License: BSD-3-Clause
Classifier: Intended Audience :: Developers
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 :: Software Development :: Libraries
License-File: LICENSE.txt
License-File: AUTHORS.rst
Requires-Dist: vivarium_dependencies[numpy,pandas,scipy]
Requires-Dist: vivarium_build_utils<4.0.0,>=3.0.2
Provides-Extra: test
Requires-Dist: vivarium_dependencies[pytest]; extra == "test"
Provides-Extra: docs
Requires-Dist: vivarium_dependencies[sphinx]; extra == "docs"
Provides-Extra: interactive
Requires-Dist: vivarium_dependencies[interactive]; extra == "interactive"
Provides-Extra: dev
Requires-Dist: vivarium_dependencies[pytest]; extra == "dev"
Requires-Dist: vivarium_dependencies[sphinx]; extra == "dev"
Requires-Dist: vivarium_dependencies[interactive]; extra == "dev"
Requires-Dist: vivarium_dependencies[lint]; 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

Risk Distributions
======================

**NOTE: This repository is archived and will receive no further updates.**

The ``risk_distributions`` package has been renamed and migrated into the
`vivarium-suite monorepo <https://github.com/ihmeuw/vivarium-suite>`_.

What changed
------------

- **PyPI distribution:** ``risk_distributions`` -> ``vivarium-risk-distributions``
- **Import path:** ``risk_distributions`` -> ``vivarium.risk_distributions``
- **Source:** ``ihmeuw/risk_distributions`` (archived) ->
  ``ihmeuw/vivarium-suite`` (under ``libs/risk-distributions/``)
- **Docs:** https://vivarium-risk-distributions.readthedocs.io/

The final release on PyPI (``v2.3.5``) ships the same code as ``v2.3.4`` with
this banner added. ``v2.4.0`` shipped a metapackage/shim that has since been
yanked; the archived repo's final release is ``v2.3.5``. ``pip install risk_distributions``
will keep resolving and importing as it did in ``v2.3.4``, but the code is frozen
and will not receive updates.

To migrate fully to the new package
-----------------------------------

**Install:**

.. code-block:: bash

    pip install vivarium-risk-distributions  # was: pip install risk_distributions

**Import:**

.. code-block:: python

    import vivarium.risk_distributions  # was: import risk_distributions

Original package overview
=========================

.. image:: https://badge.fury.io/py/risk_distributions.svg
    :target: https://badge.fury.io/py/risk-distributions

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

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

This library contains various probability distributions, compatible for use with the ``Vivarium`` framework

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

  ``> pip install risk_distributions``

or build it from source with

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

  ``> cd risk_distributions``

  ``> python setup.py install``


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