Metadata-Version: 2.4
Name: agraphx
Version: 2025.12.18.1
Maintainer-email: Andrew Tarzia <andrew.tarzia@gmail.com>
Project-URL: github, https://github.com/andrewtarzia/agx
Project-URL: documentation, https://agx.readthedocs.io
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: rustworkx
Requires-Dist: networkx
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pytest<8; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-copybutton; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: sphinx_rtd_theme; extra == "dev"
Requires-Dist: furo; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Requires-Dist: moldoc; extra == "dev"
Dynamic: license-file

:maintainers:
  `andrewtarzia <https://github.com/andrewtarzia/>`_
:documentation: https://agx.readthedocs.io/en/latest/


Overview
========

``agx`` (a graph explorer) is toolkit for enumerating graphs in the context
of structure prediction.

.. important::

  **Warning**: This package is still very much underdevelopment and many changes
  are expected.

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

``agx`` can be installed with pip:

.. code-block:: bash

  pip install agraphx

Developer Setup
---------------

To develop with ``agx``, you can clone the repo and use
`just <https://github.com/casey/just>`_ and `uv <https://docs.astral.sh>`_
to setup the dev environment:

.. code-block:: bash

  just setup


Usage
=====

Examples of usage can be seen in
`cgexplore <https://cgexplore.readthedocs.io/en/latest/>`_.

How To Cite
===========

If you use ``agx``, please cite this URL

  https://github.com/andrewtarzia/agx

And consider citing ``cgexplore``

  https://github.com/andrewtarzia/CGExplore

Acknowledgements
================

Funded by the European Union - Next Generation EU, Mission 4 Component 1
CUP E13C22002930006.

This work is now developed as part of the `Tarzia Research Group at the
University of Birmingham <https://tarziaresearchgroup.github.io>`_.
