# Welcome to *sqsgenerator*'s documentation!

## Highlights

  - Easy integration with popular frameworks such as [*ase*](https://wiki.fysik.dtu.dk/ase/),
    [*pymatgen*](https://pymatgen.org/) and [*pyiron*](https://pyiron.org/)
  - Monte-Carlo and systematic approach to compute optimal atomic configuration
  - **Carefully hand-crafted** low-level C++ routines, for efficient calculation of short-range-order
  - [*OpenMP*](https://www.openmp.org/) parallelized by default, with additional support for MPI parallelization
  - Light dependency footprint 
  - Intuitive to use
  - Command line interface
  - Simple to use Python API

I would highly, appreciate, if you cite our [article](https://doi.org/10.1016/j.cpc.2023.108664) in case you use the 
software in your research. Here is the {download}`BibTeX entry <citation.bib>`. Many thanks in advance =)

## Table of contents

```{toctree}
--- 
maxdepth: 1
---

installation_guide
how_to
input_parameters
advanced_topics
what_is_actually_computed
who_uses_sqsgenerator
cli_interface
api_reference
```

## API Reference
* {ref}`genindex`
* {ref}`search`