.. Dyn-Core documentation master file, created by
   sphinx-quickstart on Fri Dec  8 17:18:29 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

########
Dyn-Core
########

This package contains the common utilities used among the ``dyn`` package suite.
As it is packaged with the suite requirements, you generally don't need to install it specifically.

You can have a look at `dyn-benchmark <https://dyn-benchmark.readthedocs.io/en/latest/>`_
which uses this package for generating and analyzing benchmarks of dynamic networks of communities.

Citation
========

If you use DynCore in your research, please cite:

.. code-block:: text

   Brisson, L., Bothorel, C., & Duminy, N. (2025). DynBenchmark: Customizable GroundTruths
   to Benchmark Community Detection and Tracking in Temporal Networks, France's International Conference on Complex Systems (FRCCS 2025), Bordeaux, France

BibTeX:

.. code-block:: bibtex

    @inproceedings{Brisson2025DynBenchmark,
       title={DynBenchmark: Customizable Ground Truths to Benchmark Community Detection and Tracking in Temporal Networks},
       author={Brisson, Laurent and Bothorel, C{\'e}cile and Duminy, Nicolas},
       booktitle={France's International Conference on Complex Systems (FRCCS 2025)},
       year={2025}
    }

.. toctree::
   :maxdepth: 1
   :hidden:

   Homepage <self>

.. toctree::
   :maxdepth: 1
   :caption: GETTING STARTED
   :hidden:

   install

.. toctree::
   :caption: REFERENCE MANUAL
   :hidden:

   api

Contributing
============

This package is growing continuously and contributions are welcomed.
Contributions can come in the form of new features, bug fixes, documentation improvements
or any combination thereof.

If you want to contribute to this package, please read the :doc:`Contributing guidelines <contributing>`.
If you have any new ideas or have found bugs, feel free to `create an issue <https://gitlab.com/decide.imt-atlantique/dyn/core/-/issues/new>`_.
Finally, any contribution must be proposed for integration as a `Merge Request <https://gitlab.com/decide.imt-atlantique/dyn/core/-/merge_requests/new>`_.

Please visit our `Gitlab <https://gitlab.com/decide.imt-atlantique/dyn/core>`_ for more details.

License
=======

This software is licensed under the `European Union Public Licence (EUPL) v1.2 <https://joinup.ec.europa.eu/page/eupl-text-11-12>`_.
For more information see `this <https://gitlab.com/decide.imt-atlantique/dyn/core/-/blob/main/LICENSE>`_.

.. toctree::
   :caption: SUPPORT AND CONTRIBUTION
   :hidden:

   contributing
   troubleshoots
   Issues <https://gitlab.com/decide.imt-atlantique/dyn/core/-/issues>
   Gitlab <https://gitlab.com/decide.imt-atlantique/dyn/core>