Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README update with pyOpenSci review suggestions: repotatus badge; target-audience paragraph; Fortran/CMake dependency mentioned earlier on #396

Merged
merged 2 commits into from
Jan 30, 2025
Merged

README update with pyOpenSci review suggestions: repotatus badge; target-audience paragraph; Fortran/CMake dependency mentioned earlier on #396

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05cd3b2
README update with pyOpenSci review suggestions: repotatus badge; tar…
slayoo Jan 28, 2025
1fda4b3
clarify dependencies sentence
slayoo Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@

PyPartMC is a Python interface to [PartMC](https://lagrange.mechse.illinois.edu/partmc/),
a particle-resolved Monte-Carlo code for atmospheric aerosol simulation.
Development of PyPartMC has been intended to remove limitations to the use of Fortran-implemented PartMC.
PyPartMC facilitates the dissemination of computational research results by streamlining independent execution
of PartMC simulations (also during peer-review processes).
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.

PyPartMC is implemented in C++ and it also constitutes a C++ API to the PartMC Fortran internals.
The Python API can facilitate using PartMC from other environments - see, e.g., Julia and Matlab examples below.

Expand All @@ -19,6 +26,7 @@ If interested in contributing to PyPartMC, please have a look a the [notes for d
[![API docs](https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg)](https://open-atmos.github.io/PyPartMC/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7662635.svg)](https://doi.org/10.5281/zenodo.7662635)
[![PyPI version](https://badge.fury.io/py/PyPartMC.svg)](https://pypi.org/p/PyPartMC)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

## TL;DR (try in a Jupyter notebook)

Expand All @@ -33,6 +41,12 @@ If interested in contributing to PyPartMC, please have a look a the [notes for d
import PyPartMC
```

Note that, depending on the environment (OS, hardware, Python version), the pip-install invocation
may either trigger a download of a pre-compiled binary, or trigger compilation of PyPartMC.
In the former case, all dependencies will be resolved by pip.
In the latter case, a Fortran compiler and some development tools includiong CMake, m4 and perl
are required.

#### Jupyter notebooks with examples
Note: clicking the badges below redirects to cloud-computing platforms. The mybinder.org links allow anonymous execution, Google Colab requires logging in with a Google account, ARM JupyerHub requires logging in with an ARM account (and directing Jupyter to a particular notebook within the `examples` folder).

Expand Down
Loading