mcpartools is a command-line tool that simplifies and accelerates particle transport simulations using Monte Carlo codes like FLUKA and SHIELD-HIT12A. It’s designed for users with access to HPC clusters (e.g., SLURM, Torque), allowing large-scale simulations to run in parallel across multiple compute nodes with minimal manual setup.
- Generates all necessary directory structures and job scripts
- Supports distributed batch execution and result collection
- Works out-of-the-box with Linux clusters
- No programming required — just basic terminal usage
mcpartools
is a Python-based tool and requires Python and Linux to run.
Install and start using the CLI tool:
pip install mcpartools
generatemc --help
✅ Tip: See our Getting Started guide for detailed setup instructions.
Full documentation is available at: 📖 https://mcpartools.readthedocs.io/
You're running FLUKA or SHIELD-HIT12A simulations and want to:
- Distribute workloads over dozens of cluster nodes
- Automatically prepare job scripts and directories
- Collect and organize simulation outputs efficiently
Then mcpartools
is the automation tool you're looking for.
Contributions are welcome! Feel free to open issues or submit pull requests.
To set up a development environment:
git clone https://github.com/DataMedSci/mcpartools.git
cd mcpartools
pip install -e .[dev]
This project is licensed under the GNU General Public License v3.0.