Welcome to Hypergraphx's docs!
========================================

.. image:: ../assets/logo/logo.png
  :width: 160

Hypergraphx (HGX) is a Python library for higher-order network analysis.

.. toctree::
   :maxdepth: 2
   :caption: 🚀 Get Started
   :class: index-toc

   installation
   quickstart
   tutorials

.. toctree::
   :maxdepth: 2
   :caption: 📖 API Reference
   :class: index-toc

   api/hypergraphx

Project links
-------------

.. |fa-arxiv| raw:: html

   <i class="fa-regular fa-file-lines"></i>

.. |fa-github| raw:: html

   <i class="fa-brands fa-github"></i>

.. |fa-pypi| raw:: html

   <i class="fa-brands fa-python"></i>

.. |fa-docs| raw:: html

   <i class="fa-solid fa-book-open"></i>

.. |fa-data| raw:: html

   <i class="fa-solid fa-database"></i>

.. rst-class:: project-links

- |fa-arxiv| `Arxiv <https://arxiv.org/pdf/2303.15356.pdf>`_
- |fa-github| `GitHub <https://github.com/HGX-Team/hypergraphx>`_
- |fa-pypi| `PyPI <https://pypi.org/project/hypergraphx/>`_
- |fa-docs| `Documentation <https://hypergraphx.readthedocs.io/>`_
- |fa-data| Data: To appear soon

Get started
-----------

.. list-table::
   :widths: 28 72
   :header-rows: 0
   :class: get-started

   * - :doc:`⚙️ Installation <installation>`
     - Install HGX from PyPI or source, then verify it works.
   * - :doc:`🚀 Quickstart <quickstart>`
     - Create your first hypergraph and compute basic measures.
   * - :doc:`📚 Tutorials <tutorials>`
     - Notebook-driven examples for workflows and models.

Higher-order data repository
----------------------------

To appear soon

Reference
---------

* Lotito, Quintino Francesco, et al. "Hypergraphx: a library for higher-order network analysis." Journal of Complex Networks 11.3 (2023): cnad019.

Contributing
------------

HGX is a collaborative project and we welcome suggestions and contributions.
If you are interested in contributing to HGX or have any questions about our project, please do not hesitate to reach out to us.
We look forward to hearing from you!

HGX Team
--------

Project coordinators:

* Quintino Francesco Lotito
* Federico Battiston

Core members:

* Martina Contisciani
* Caterina De Bacco
* Leonardo Di Gaetano
* Luca Gallo
* Alberto Montresor
* Federico Musciotto
* Nicolò Ruggeri

License
-------

This project is licensed under the `BSD 3-Clause License
<https://github.com/HGX-Team/hypergraphx/blob/main/LICENSE.md>`_.

Copyright |copyright|