# init-mater-project

[![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
[![PyPI version](https://badge.fury.io/py/init-mater-project.svg)](https://pypi.org/project/init-mater-project/)
[![License](https://img.shields.io/badge/license-LGPLv3-blue.svg)](LICENSE)

**Project scaffolding tool for MATER simulation framework.**

## Quick Start

```bash
# Run without install — recommended
uvx init-mater-project my-simulation

# Or install globally
pip install init-mater-project

# Navigate and start
cd my-simulation
uv run mater-cli run --example
```

`init-mater-project` creates a complete MATER project with:
- Configuration templates
- Data pipeline structure  
- CLI toolchain
- Example datasets
- Documentation

## Generated Project

See generated `README.md` in your project for usage instructions.

## Documentation

- **MATER Framework**: [mater-framework.org](https://mater-framework.org)
- **Contributing**: `CONTRIBUTING.md`
- **Changelog**: `CHANGELOG.md`

## License

LGPLv3 License - see `LICENSE` file for details.