particula 0.0.1

a simple, fast, and powerful particle simulator

PARTICULA

Particula is a simple, fast, and powerful particle simulator, or at least two of the three, we hope. It is a simple particle system that is designed to be easy to use and easy to extend. The goal is to have a robust aerosol (gas phase and particle phase) simulation system that can be used to answer scientific questions that arise for experiments and research discussions.

(DISCLAIMER GitHub Copilot is heavily involved in the development of this project and especially in the writing of these paragraphs! DISCLAIMER)

(WARNING PARTICULA is in early and messy development. It is not ready for production use yet, but you are welcome to use it anyway --- even better, you're welcome to contribute WARNING)

Goals & conduct

The main goal is to develop an aerosol particle model that is usable, efficient, and productive. In this process, we all will learn developing models in Python and associated packages. Let us all be friendly, respectful, and nice to each other. Any code added to this repository is automatically owned by all. Please speak up if something (even if trivial) bothers you. Talking through things always helps. This is an open-source project, so feel free to contribute, however small or big your contribution may be.

We follow the Google Python style guide here. We have contribution guidelines here and a code of conduct here as well.

Usage & development

The development of this model will be illustrated through Jupyter notebooks (here) that will be put together in the form of a Jupyter book on our website. You can install particula from PyPI or conda-forge with pip install particula or conda install -c conda-forge particula.