A MATER project generator
Project description
init-mater-project
CLI tool to transform raw datasets into MATER-ready data and run your own MATER simulations.
Quick Start
You can create a new MATER project:
# Run without install — recommended
uvx init-mater-project my-project
# Or
pipx run init-mater-project my-project
cd my-project
Alternatively, you can initialize a project in the working directory:
mkdir my-project
cd my-project
# Run without install — recommended
uvx init-mater-project
# Or
pipx run init-mater-project
cd my-simulation
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
- CLI toolchain
- Outputs visualisation app
- Example datasets
- Documentation
Documentation
- Detailed Documentation — MkDocs with configuration, user guide, developer guide, testing, deployment, architecture
- Changelog
- Contributing
- License — LGPLv3 License details
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file init_mater_project-0.2.0.tar.gz.
File metadata
- Download URL: init_mater_project-0.2.0.tar.gz
- Upload date:
- Size: 409.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
99b930206f8e6138a092761e57c5691e2153b608ca2a486f5ee472a008e21e94
|
|
| MD5 |
c9ea4911c2c435dac6016553d62c03f7
|
|
| BLAKE2b-256 |
395f33b07932dbbf513c84a505480c77beeeb3da02126951cf58a3d3dcf28cc6
|
File details
Details for the file init_mater_project-0.2.0-py3-none-any.whl.
File metadata
- Download URL: init_mater_project-0.2.0-py3-none-any.whl
- Upload date:
- Size: 407.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
60b6ed3d7e4ad2e141a38e40021e0294afe0baf6b979761b0066a6a2161b6e17
|
|
| MD5 |
90923e2df77eab7d0b9e69d17c0df6ab
|
|
| BLAKE2b-256 |
a187adf51bf3ea2855e0ad1b7a36424a701342f3dc12d89a7819e48355502a6d
|