https://github.com/datamedsci/mcpartools
Set of tools to parallelize MC tools on clusters
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
2 of 9 committers (22.2%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (18.4%) to scientific vocabulary
Keywords from Contributors
Repository
Set of tools to parallelize MC tools on clusters
Basic Info
- Host: GitHub
- Owner: DataMedSci
- License: gpl-3.0
- Language: Python
- Default Branch: master
- Homepage: https://mcpartools.readthedocs.io/
- Size: 221 KB
Statistics
- Stars: 6
- Watchers: 2
- Forks: 5
- Open Issues: 20
- Releases: 0
Metadata Files
README.md
mcpartools
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.
🚀 Features
- 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
🛆 Installation & Usage
mcpartools is a Python-based tool and requires Python and Linux to run.
Install and start using the CLI tool:
bash
pip install mcpartools
generatemc --help
✅ Tip: See our Getting Started guide for detailed setup instructions.
📚 Documentation
Full documentation is available at: 📖 https://mcpartools.readthedocs.io/
💡 Example Use Case
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.
🛠 Development
Contributions are welcome! Feel free to open issues or submit pull requests.
To set up a development environment:
bash
git clone https://github.com/DataMedSci/mcpartools.git
cd mcpartools
pip install -e .[dev]
📟 License
This project is licensed under the GNU General Public License v3.0.
Owner
- Name: DataMedSci
- Login: DataMedSci
- Kind: organization
- Repositories: 9
- Profile: https://github.com/DataMedSci
GitHub Events
Total
- Create event: 38
- Release event: 4
- Issues event: 19
- Watch event: 2
- Delete event: 45
- Member event: 1
- Issue comment event: 26
- Push event: 55
- Pull request review comment event: 28
- Pull request review event: 60
- Pull request event: 69
Last Year
- Create event: 38
- Release event: 4
- Issues event: 19
- Watch event: 2
- Delete event: 45
- Member event: 1
- Issue comment event: 26
- Push event: 55
- Pull request review comment event: 28
- Pull request review event: 60
- Pull request event: 69
Committers
Last synced: over 3 years ago
All Time
- Total Commits: 123
- Total Committers: 9
- Avg Commits per committer: 13.667
- Development Distribution Score (DDS): 0.667
Top Committers
| Name | Commits | |
|---|---|---|
| Leszek Grzanka | l****a@g****m | 41 |
| pyup.io bot | g****t@p****o | 32 |
| dependabot[bot] | 4****]@u****m | 28 |
| Leszek Grzanka | g****a@a****l | 7 |
| Leszek Grzanka | L****a@i****l | 7 |
| Aga Rudnicka | a****6@u****m | 4 |
| PanSzczerba | p****a@g****m | 2 |
| DeepSource Bot | b****t@d****o | 1 |
| ant6 | a****t@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 21
- Total pull requests: 266
- Average time to close issues: over 1 year
- Average time to close pull requests: 4 months
- Total issue authors: 3
- Total pull request authors: 7
- Average comments per issue: 0.05
- Average comments per pull request: 0.86
- Merged pull requests: 157
- Bot issues: 0
- Bot pull requests: 209
Past Year
- Issues: 17
- Pull requests: 80
- Average time to close issues: 4 days
- Average time to close pull requests: 1 day
- Issue authors: 2
- Pull request authors: 3
- Average comments per issue: 0.06
- Average comments per pull request: 0.68
- Merged pull requests: 65
- Bot issues: 0
- Bot pull requests: 57
Top Authors
Issue Authors
- grzanka (11)
- krisx303 (9)
- marcelosousa (1)
Pull Request Authors
- dependabot[bot] (208)
- pyup-bot (25)
- krisx303 (21)
- leskiw77 (8)
- grzanka (2)
- olszowski (1)
- reviewpad[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 62 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 27
- Total maintainers: 1
pypi.org: mcpartools
Set of tools to parallelize MC calculations on clusters
- Homepage: https://github.com/DataMedSci/mcpartools
- Documentation: https://mcpartools.readthedocs.io/
- License: GPL
-
Latest release: 0.6.2
published over 7 years ago
Rankings
Maintainers (1)
Dependencies
- pytest ==4.6.3 test
- pytest-catchlog ==1.2.2 test
- pytest-cov ==2.7.1 test
- pytest-timeout ==1.3.4 test
- pytest-xdist ==1.29.0 test
- tox ==3.2.0 test
- versioneer <0.18 test