Metadata-Version: 2.1
Name: particula
Version: 0.0.1
Summary: a simple, fast, and powerful particle simulator
Home-page: https://github.com/uncscode/particula
Author: aktwo, Gorkowski, ngam, wkchuang
Author-email: aktwo@users.noreply.github.com, Gorkowski@users.noreply.github.com, ngam@users.noreply.github.com, wkchuang@users.noreply.github.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/uncscode/particula/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# *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](https://google.github.io/styleguide/pyguide.html). We have contribution guidelines [here](./CONTRIBUTING.md) and a code of conduct [here](./CODE_OF_CONDUCT.md) as well.

## Usage & development

The development of this model will be illustrated through Jupyter notebooks ([here](./docs/)) that will be put together in the form of a Jupyter book on our [website](https://uncscode.github.io/particula). You can install `particula` from PyPI or conda-forge with `pip install particula` or `conda install -c conda-forge particula`.


