Metadata-Version: 2.4
Name: laser-core
Version: 0.5.1
Summary: Core functionality for the Light Agent Spatial modeling for ERadication toolkit (LASER).
Author-email: Christopher Lorton <christopher.lorton@gatesfoundation.org>, Jonathan Bloedow <jonathan.bloedow@gatesfoundation.org>, Katherine Rosenfeld <katherine.rosenfeld@gatesfoundation.org>, Kevin McCarthy <kevin.mccarthy@gatesfoundation.org>
Maintainer-email: Christopher Lorton <christopher.lorton@gatesfoundation.org>, Jonathan Bloedow <jonathan.bloedow@gatesfoundation.org>
License: MIT License
        
        Copyright (c) 2023 - 2024 Bill & Melinda Gates Foundation
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/InstituteforDiseaseModeling/laser
Project-URL: Issues, https://github.com/InstituteforDiseaseModeling/laser/issues
Project-URL: Documentation, https://docs.idmod.org/projects/laser/en/latest/
Project-URL: Changelog, https://docs.idmod.org/projects/laser/en/latest/changelog.html
Keywords: spatial modeling,disease eradication,agent-based modeling
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: <3.13,>=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: click
Requires-Dist: numpy
Requires-Dist: numba
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: h5py
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: uv; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=1.3; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: furo; extra == "docs"
Provides-Extra: test
Requires-Dist: pytest>=6.0; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: scipy; extra == "test"
Requires-Dist: uv; extra == "test"
Dynamic: license-file

========
Overview
========

.. start-badges

.. list-table::
    :stub-columns: 1

    * - docs
      - |docs|
    * - tests
      - | |github-actions|
        | |codecov|
    * - package
      - | |version| |wheel| |supported-versions| |supported-implementations|
        | |commits-since|
.. |docs| image:: https://readthedocs.org/projects/idmlaser/badge/?style=flat
    :target: https://docs.idmod.org/projects/laser/en/latest/
    :alt: Documentation Status

.. |github-actions| image:: https://github.com/InstituteforDiseaseModeling/laser/actions/workflows/github-actions.yml/badge.svg
    :alt: GitHub Actions Build Status
    :target: https://github.com/InstituteforDiseaseModeling/laser/actions

.. |codecov| image:: https://codecov.io/gh/InstituteforDiseaseModeling/laser/branch/main/graphs/badge.svg?branch=main
    :alt: Coverage Status
    :target: https://app.codecov.io/github/InstituteforDiseaseModeling/laser

.. |version| image:: https://img.shields.io/pypi/v/laser-core.svg
    :alt: PyPI Package latest release
    :target: https://pypi.org/project/laser-core/

.. |wheel| image:: https://img.shields.io/pypi/wheel/laser-core.svg
    :alt: PyPI Wheel
    :target: https://pypi.org/project/laser-core/

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/laser-core.svg
    :alt: Supported versions
    :target: https://pypi.org/project/laser-core/

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/laser-core.svg
    :alt: Supported implementations
    :target: https://pypi.org/project/laser-core/

.. |commits-since| image:: https://img.shields.io/github/commits-since/InstituteforDiseaseModeling/laser/v0.5.1.svg
    :alt: Commits since latest release
    :target: https://github.com/InstituteforDiseaseModeling/laser/compare/v0.5.1...main



.. end-badges

Light Agent Spatial modeling for ERadication.

* Free software: MIT license

Installation
============

::

    pip install laser-core

You can also install the in-development version with::

    pip install https://github.com/InstituteforDiseaseModeling/laser/archive/main.zip


Documentation
=============


https://docs.idmod.org/projects/laser/en/latest/


Development
===========

To run all the tests run::

    tox

Note, to combine the coverage data from all the tox environments run:

.. list-table::
    :widths: 10 90
    :stub-columns: 1

    - - Windows
      - ::

            set PYTEST_ADDOPTS=--cov-append
            tox

    - - Other
      - ::

            PYTEST_ADDOPTS=--cov-append tox
