Metadata-Version: 2.3
Name: graphmix
Version: 0.0.2
Summary: Intelligent experiment planning and optimization powered by graph algorithms.
Project-URL: Documentation, https://python-graphmix.readthedocs.io/
Project-URL: Changelog, https://python-graphmix.readthedocs.io/en/latest/changelog.html
Project-URL: Issues, https://github.com/jt05610/python-graphmix/issues
Project-URL: Repository, https://github.com/jt05610/python-graphmix.git
Project-URL: Homepage, https://github.com/jt05610/python-graphmix
Author-email: Jonathan Taylor <jonrtaylor12@gmail.com>
Maintainer-email: Jonathan Taylor <jonrtaylor12@gmail.com>
License: MIT License
        
        Copyright (c) 2024, Jonathan Ross Taylor
        
        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.
License-File: AUTHORS.rst
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: matplotlib~=3.9.0
Requires-Dist: networkx~=3.3
Requires-Dist: pint~=0.23
Requires-Dist: pydantic~=2.7.1
Requires-Dist: requests-ratelimiter~=0.6.0
Requires-Dist: requests~=2.32.2
Requires-Dist: scipy~=1.13.1
Requires-Dist: sqlmodel~=0.0.18
Description-Content-Type: text/x-rst

========
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/python-graphmix/badge/?style=flat
    :target: https://readthedocs.org/projects/python-graphmix/
    :alt: Documentation Status

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

.. |codecov| image:: https://codecov.io/gh/jt05610/python-graphmix/branch/main/graphs/badge.svg?branch=main
    :alt: Coverage Status
    :target: https://app.codecov.io/github/jt05610/python-graphmix

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

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

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

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

.. |commits-since| image:: https://img.shields.io/github/commits-since/jt05610/python-graphmix/v0.0.2.svg
    :alt: Commits since latest release
    :target: https://github.com/jt05610/python-graphmix/compare/v0.0.2...main



.. end-badges

Intelligent experiment planning and optimization powered by graph algorithms.

* Free software: MIT license

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

::

    pip install graphmix

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

    pip install https://github.com/jt05610/python-graphmix/archive/main.zip


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


https://python-graphmix.readthedocs.io/


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
