Getting Started
Welcome to DataSynth! This section will help you get up and running quickly.
What You’ll Learn
- Installation: Set up DataSynth on your system
- Quick Start: Generate your first synthetic dataset
- Demo Mode: Explore DataSynth with built-in demo presets
Prerequisites
Before you begin, ensure you have:
- Rust 1.88+: DataSynth is written in Rust and requires the Rust toolchain
- Git: For cloning the repository
- (Optional) Node.js 18+: Required only for the desktop UI
Installation Overview
# Clone and build
git clone https://github.com/mivertowski/SyntheticData.git
cd SyntheticData
cargo build --release
# The binary is at target/release/datasynth-data
First Steps
The fastest way to explore DataSynth is through demo mode:
datasynth-data generate --demo --output ./demo-output
This generates a complete set of synthetic financial data using sensible defaults.
Architecture at a Glance
DataSynth generates interconnected financial data:
┌─────────────────────────────────────────────────────────────┐
│ Configuration (YAML) │
├─────────────────────────────────────────────────────────────┤
│ Generation Pipeline │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
│ │ Master │→│ Document │→│ Journal │→│ Output │ │
│ │ Data │ │ Flows │ │ Entries │ │ Files │ │
│ └──────────┘ └──────────┘ └──────────┘ └──────────┘ │
├─────────────────────────────────────────────────────────────┤
│ Output: CSV, JSON, Parquet, Neo4j, PyTorch Geometric │
└─────────────────────────────────────────────────────────────┘
Next Steps
- Follow the Installation Guide to set up your environment
- Work through the Quick Start Tutorial
- Explore Demo Mode for a hands-on introduction
- Review the CLI Reference for all available commands
Getting Help
- Check the User Guide for detailed usage instructions
- Review Configuration for all available options
- See Use Cases for real-world examples