init-mater-project 0.3.0

A MATER project generator

init-mater-project

CLI tool to transform raw datasets into MATER-ready data and run your own MATER simulations.

Quick Start

Initialize a MATER project in an existing directory:

cd my-project

# Run without install — recommended
uvx init-mater-project
# Or 
pipx run init-mater-project

Or create a MATER project in a new directory:

# Run without install — recommended
uvx init-mater-project my-project
# Or 
pipx run init-mater-project my-project

cd my-project

Run and visualise your first MATER simulation:

uv run mater-cli simulation run --example

# Visualise outputs
uv run mater-cli simulation serve --example

init-mater-project creates a complete MATER project with:

• Configuration templates
• Data pipeline structure with interactive Jupyter notebooks
• CLI toolchain
• Example datasets
• Documentation

Documentation

• Detailed Documentation — MkDocs with configuration, user guide, developer guide, testing, deployment, architecture
• Changelog
• Contributing
• License — LGPLv3 License details, third-party dependencies are listed in THIRD_PARTY_LICENSES.md