.. MacSyLib - python library that provide functions for
   detection of macromolecular systems in protein datasets
   using systems modelling and similarity search.
   Authors: Sophie Abby, Bertrand Néron
   Copyright © 2014-2025 Institut Pasteur (Paris) and CNRS.
   See the COPYRIGHT file for details
   MacSyLib is distributed under the terms of the GNU General Public License (GPLv3).
   See the COPYING file for details.



.. image:: _static/logo_macsylib.png
   :align: center
   :alt: MacSyLib logo


MacSyLib documentation
======================


MacSyLib is a Python package library that allow to model and detect macromolecular systems, genetic pathways…
by similarity search in prokaryotes datasets.


.. note::

  If you use MacSyLib please cite:

  `Néron, Bertrand; Denise, Rémi; Coluzzi, Charles; Touchon, Marie; Rocha, Eduardo P.C.; Abby, Sophie S.
  MacSyFinder v2: Improved modelling and search engine to identify molecular systems in genomes.
  Peer Community Journal, Volume 3 (2023), article no. e28.
  doi : 10.24072/pcjournal.250.
  https://peercommunityjournal.org/articles/10.24072/pcjournal.250/ <https://peercommunityjournal.org/articles/10.24072/pcjournal.250/>`_



==========
User Guide
==========
.. toctree::
   :maxdepth: 2

   user_guide/index


==============
Modeller Guide
==============

.. toctree::
   :maxdepth: 2

   modeler_guide/index


===============
Developer Guide
===============

.. toctree::
   :maxdepth: 2

   developer_guide/index



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
