# Abacus Documentation

Welcome to the documentation for the Abacus Marketing Mix Modelling (MMM) library.

Abacus provides a comprehensive framework for building, analysing, and optimising MMMs using Bayesian methods with PyMC.

```{toctree}
:maxdepth: 2
:caption: Contents:

getting-started/index
guides/index
explanation/index
reference/index
troubleshooting/index
testing/index
```

## Documentation Structure

This documentation is organised into four main sections based on the [Diátaxis framework](https://diataxis.fr/):

1.  **[Getting Started](./getting-started/index.md):** Tutorials for new users, covering installation, data preparation, and running a basic model.
2.  **[How-to Guides](./guides/index.md):** Practical step-by-step guides for accomplishing specific tasks, such as configuring the model, interpreting results, and performing optimisation.
3.  **[Explanation](./explanation/index.md):** Conceptual discussions explaining the underlying methodology, model components, and statistical concepts.
4.  **[Reference](./reference/index.md):** Technical details, including the API reference, configuration parameter definitions, and output file descriptions.
5.  **[Troubleshooting](./troubleshooting/index.md):** Solutions for common errors, performance tips, and debugging strategies.
6.  **[Testing](./testing/index.md):** Information on running the test suite, understanding test structure, and contributing tests.