Getting Started

Welcome to the synthpop-py documentation. This guide will help you install synthpop-py, learn the basic workflow for synthetic data generation, and create your first synthetic dataset.

synthpop-py is a Python package for generating synthetic tabular data while preserving important statistical patterns and relationships from the original dataset. It provides a reproducible workflow for generating synthetic records and evaluating the quality of the results.

If you are new to synthpop-py, we recommend following these guides in order:

1. Installation — Install synthpop-py.

2. Workflow, structure and key concepts — Learn about the synthesis workflow, key concepts, and how synthpop-py approaches synthetic data generation.

3. Your first synthesis — Create your first synthetic dataset and inspect the results.

If you want to know more about synthpop-py, please see the About Us page.

After completing these steps, explore more advanced examples and workflows in the User Guide.

If you get stuck along the way, take a look at our FAQ for answers to common questions and issues.

For detailed information about available functions, classes, and parameters, see the API reference.