.. toctree::
   :hidden:
   :caption: agraphx
   :maxdepth: 1

   Graphs <graphs>
   Available graphs <avail_graphs>
   Recipes <recipes>
   Utilities <utilities>

.. toctree::
  :hidden:
  :maxdepth: 2
  :caption: Modules:

  Modules <modules>

============
Introduction
============

| GitHub: https://www.github.com/andrewtarzia/agx


:mod:`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.


.. tip::

  ⭐ Star us on `GitHub <https://www.github.com/andrewtarzia/agx>`_! ⭐


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

:mod:`agx` can be installed with pip:

.. code-block:: bash

  pip install agraphx


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

To develop with :mod:`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


Examples
========

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>`_.