PAPRECA

PAPRECA: A parallel hybrid off-lattice kinetic Monte Carlo/molecular dynamics simulator - Published in JOSS (2024)

https://github.com/sntioudis/papreca

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Agricultural and Biological Sciences Life Sciences - 40% confidence
Last synced: 4 months ago · JSON representation ·

Repository

PAPRECA hybrid off-lattice kinetic Monte Carlo/molecular dynamics (kMC/MD) simulator

Basic Info
  • Host: GitHub
  • Owner: sntioudis
  • License: gpl-2.0
  • Language: C++
  • Default Branch: main
  • Size: 91.3 MB
Statistics
  • Stars: 11
  • Watchers: 1
  • Forks: 1
  • Open Issues: 7
  • Releases: 5
Created over 1 year ago · Last pushed 5 months ago
Metadata Files
Readme License Code of conduct Citation

README.md

PAPRECA Tests Compatibility Docs

status

PAPRECA stands for PArallel PREdefined CAtalog off-lattice kinetic Monte Carlo.

PAPRECA is a hybrid rejection-free kinetic Monte Carlo/molecular dynamics (kMC/MD) software built around LAMMPS. PAPRECA uses the Message Passing Interface (MPI) protocol to enable parallel hybrid off-lattice kMC/MD or pure off-lattice kMC studies related to a variety of systems in materials science and engineering (e.g., thin film growth and heterogeneous catalysis).

Open-source and community guidelines

PAPRECA is an open-source software that is distributed under the terms of the GNU General Public License, version 2. PAPRECA is designed as an easy-to-modify and easy-to-extend software. For example, new predefined event templates can be added to the original code.

In the spirit of open source, we encourage contributions from other Authors! Kindly use pull requests to contribute to the code after ensuring your local fork passes ALL tests. Furthermore, you can use GitHub issues for other forms of contribution (e.g., bug fixes, code optimization, new examples, corrections to documentation). Note that, development will solely be performed on the main branch. Merges with the release branch will only happen after ensuring that the code on the main branch is ready for production. Appropriate (semantic) versioning tags will be used to link the released version against the relevant commit.

Additionally, enquiries can be directed to the original developer of this software, Stavros Ntioudis, via e-mail: stavros.ntioudis20@imperial.ac.uk.

In any case, kindly review our Code of Conduct before participating in our community.

Documentation

For additional information (installation, dependencies, theory, algorithms, examples, and more) about PAPRECA please visit our documentation pages.

Citing PAPRECA

If you use PAPRECA for your research, kindly give credit to the PAPRECA [1], [2] and LAMMPS [3] developers by citing the following papers:

[1] Ntioudis, S., et al. "PAPRECA: A parallel hybrid off-lattice kinetic Monte Carlo/molecular dynamics simulator", Journal of Open Source Software, 9(98), 6714 (2024). https://doi.org/10.21105/joss.06714

[2] Ntioudis, S., et al. "A hybrid off-lattice kinetic Monte Carlo/molecular dynamics method for amorphous thin film growth", Computational Materials Science, 229, 112421 (2023). https://doi.org/10.1016/j.commatsci.2023.112421

[3] Thompson, A.P. et al. "LAMMPS - a flexible simulation tool for particle-based materials modeling at the atomic, meso, and continuum scales", Computer Physics Communications, 272, 108171 (2022). https://doi.org/10.1016/j.cpc.2021.108171

Owner

  • Name: Stavros Ntioudis
  • Login: sntioudis
  • Kind: user

PhD Student at Imperial College London

JOSS Publication

PAPRECA: A parallel hybrid off-lattice kinetic Monte Carlo/molecular dynamics simulator
Published
June 13, 2024
Volume 9, Issue 98, Page 6714
Authors
Stavros Ntioudis ORCID
Department of Mechanical Engineering, Imperial College London, London, SW7 2BX, United Kingdom
James P. Ewen ORCID
Department of Mechanical Engineering, Imperial College London, London, SW7 2BX, United Kingdom
Daniele Dini ORCID
Department of Mechanical Engineering, Imperial College London, London, SW7 2BX, United Kingdom
C. Heath Turner ORCID
Department of Chemical and Biological Engineering, University of Alabama, Tuscaloosa, Alabama 35487, United States of America
Editor
Sarath Menon ORCID
Tags
Large-scale Atomic/Molecular Massively Parallel Simulator (LAMMPS) Message Passing Interface (MPI) Computational Materials Science Off-lattice kinetic Monte Carlo Molecular Dynamics

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Ntioudis
  given-names: Stavros
  orcid: "https://orcid.org/0009-0000-8095-1727"
- family-names: Ewen
  given-names: James P.
  orcid: "https://orcid.org/0000-0001-5110-6970"
- family-names: Dini
  given-names: Daniele
  orcid: "https://orcid.org/0000-0002-5518-499X"
- family-names: Turner
  given-names: C. Heath
  orcid: "https://orcid.org/0000-0002-5707-9480"
contact:
- family-names: Ntioudis
  given-names: Stavros
  orcid: "https://orcid.org/0009-0000-8095-1727"
doi: 10.5281/zenodo.11550493
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Ntioudis
    given-names: Stavros
    orcid: "https://orcid.org/0009-0000-8095-1727"
  - family-names: Ewen
    given-names: James P.
    orcid: "https://orcid.org/0000-0001-5110-6970"
  - family-names: Dini
    given-names: Daniele
    orcid: "https://orcid.org/0000-0002-5518-499X"
  - family-names: Turner
    given-names: C. Heath
    orcid: "https://orcid.org/0000-0002-5707-9480"
  date-published: 2024-06-13
  doi: 10.21105/joss.06714
  issn: 2475-9066
  issue: 98
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6714
  title: "PAPRECA: A parallel hybrid off-lattice kinetic Monte
    Carlo/molecular dynamics simulator"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06714"
  volume: 9
title: "PAPRECA: A parallel hybrid off-lattice kinetic Monte
  Carlo/molecular dynamics simulator"

GitHub Events

Total
  • Issues event: 3
  • Watch event: 6
  • Issue comment event: 2
  • Push event: 42
  • Fork event: 1
Last Year
  • Issues event: 3
  • Watch event: 6
  • Issue comment event: 2
  • Push event: 42
  • Fork event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 364
  • Total Committers: 3
  • Avg Commits per committer: 121.333
  • Development Distribution Score (DDS): 0.016
Past Year
  • Commits: 101
  • Committers: 1
  • Avg Commits per committer: 101.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Stavros Ntioudis 4****s 358
James Ewen j****4@i****k 5
Sarath Menon m****l@s****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 26
  • Total pull requests: 12
  • Average time to close issues: 7 days
  • Average time to close pull requests: about 2 hours
  • Total issue authors: 5
  • Total pull request authors: 2
  • Average comments per issue: 2.23
  • Average comments per pull request: 0.0
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 2
  • Average time to close issues: 2 months
  • Average time to close pull requests: 1 minute
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 0.83
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • liamhuber (12)
  • sntioudis (7)
  • jfaraudo (5)
  • srmnitc (1)
  • nesquik91 (1)
Pull Request Authors
  • sntioudis (10)
  • srmnitc (2)
Top Labels
Issue Labels
documentation (3) enhancement (3) test (1) bug (1) question (1)
Pull Request Labels

Dependencies

.github/workflows/build-reusable.yml actions
  • actions/cache v4.0.2 composite
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
.github/workflows/lammps-compatibility.yml actions
.github/workflows/documentation.yml actions
  • actions/checkout v4 composite
  • mattnotmitt/doxygen-action 1.9.1 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/workflows/run_ALLtests.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite