Open slayoo opened 2 months ago
Hey @slayoo, I'm Alex, currently serving as the Editor-in-Chief. I'm sorry it took me so long to get back to you.
PyPartMC
seems to be in scope for us. I truly appreciate the care you put into the submission, especially the comparative section. It's very valuable to a profane such as myself when it comes to evaluating submissions.
Please find below the preliminary checks.
Thank you for submitting your package for pyOpenSci review. Below are the basic checks that your package needs to pass to begin our review. If some of these are missing, we will ask you to work on them before the review process begins.
Please check our Python packaging guide for more information on the elements below.
import package
.
The package installation does not install the dependenciesREADME.md
file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.CONTRIBUTING.md
file that details how to install and contribute to the package.CODE_OF_CONDUCT.md
file.YAML
header of the issue (located at the top of the issue template).I have a few suggestions regarding the documentation:
@Batalex, thanks for the feedback! We've just started addressing the above points with a code-of-conduct PR: https://github.com/open-atmos/PyPartMC/pull/358 I'll report back here after addressing all points
@Batalex, with the following PRs just merged:
the repo and docs are improved following your suggestions:
Thank you, @slayoo, the docs look great!
PyPartMC
is a strong submission, I'll get started on finding an editor right now 🫡
thank you!
Sorry, I forgot to add something important to my previous message. Since our field of expertise is Python, the significant portion of C++ code in PyPartMC
will only be evaluated on the best effort basis (which means that maybe it won't be evaluated). Our focus will be on the Python packaging side of the project.
Submitting Author: Sylwester Arabas (@slayoo) All current maintainers: (@zdaq12, @jcurtis2, @nriemer, @mwest1066) Package Name: PyPartMC One-Line Description of Package: Python interface to PartMC aerosol-dynamics Monte-Carlo simulation package Repository Link: https://github.com/open-atmos/PyPartMC/ Version submitted: v1.2.0 Editor: TBD
Reviewer 1: TBD
Reviewer 2: TBD
Archive: TBD Version accepted: TBD Date accepted (month/day/year): TBD
Code of Conduct & Commitment to Maintain Package
Description
PyPartMC is a Python interface to PartMC, a particle-resolved Monte-Carlo code for atmospheric aerosol simulation. PyPartMC is implemented mostly in C++ (based on the pybind11 framework) with some C and Fortran boilerplate layers. PyPartMC constitutes an API to the PartMC Fortran internals. Besides empowering Python/Jupyter users, PyPartMC can facilitate using PartMC from other environments - see, e.g., Julia and Matlab examples in the project README.
Scope
Domain Specific
n/a
(atmospheric science)
Community Partnerships
n/a
(we host development as a part of the OpenAtmos initiative: https://github.com/open-atmos)
Target audience and scientific applications
Development of PyPartMC has been intended to remove limitations to the use of Fortran-implemented PartMC software. PyPartMC facilitates the dissemination of computational research results by streamlining independent execution of PartMC simulations, which could prove advantageous during peer review process. Additionally, the ability to easily package examples, simple simulations, and results in a web-based notebook allows PyPartMC to support the efforts of many members of the scientific community, including researchers, instructors, and students, with nominal software and hardware requirements.
Other Python packages with relevant feature scope
Technical checks
For details about the pyOpenSci packaging requirements, see our [packaging guide][PackagingGuide]. Confirm each of the following by checking the box. This package:
Publication Options
(we have recently published a SoftwareX paper on PyPartMC: https://doi.org/10.1016/j.softx.2023.101613)
Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?
Confirm each of the following by checking the box.
Please fill out our survey