.. repliclust documentation master file, created by
   sphinx-quickstart on Tue Dec 13 21:09:34 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Synthetic Data for Cluster Analysis
===================================

**repliclust** is a Python package for generating synthetic datasets with clusters. It allows you to generate many different datasets that are geometrically similar, but *without* ever touching low-level parameters like cluster centroids or covariance matrices.

Features
--------

- Reproducibly generate clusters with defined geometric characteristics
- Manage cluster overlaps, shapes, and probability distributions through intuitive, high-level controls
- Define custom dataset archetypes to power reproducible and informative benchmarks


Reference
---------

Check out our paper `here <https://arxiv.org/abs/2303.14301>`_.


.. toctree::
    :hidden:

    install
    user_guide
    reference
    source_code