Skip to content

Commit

Permalink
update changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Gorkowski committed Oct 4, 2024
1 parent 12e5902 commit 2bc9671
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Home

Particula is python-based aerosol particle simulator. The goal is to have a robust aerosol (gas phase *and* particle phase) simulation that can be used to answer scientific questions that arise in experiments and research endeavors.
Particula is a Python-based aerosol particle simulator. Its goal is to provide a robust aerosol simulation (including both gas and particle phases) that can be used to answer scientific questions arising from experiments and research endeavors.

## :simple-pypi: PyPi Installation

If your python environment is already set up, you can install [`Particula` via pip](https://pypi.org/project/particula/) using the following command:
If your Python environment is already set up, you can install [`Particula` via pip](https://pypi.org/project/particula/) using the following command:

``` bash
pip install particula
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,12 @@

# mass transfer abstract class
class CondensationStrategy(ABC):
"""Condensation strategy abstract class.
"""
Abstract base class for condensation strategies.
Abstract class for mass transfer strategies, for condensation or
evaporation of particles. This class should be subclassed to implement
specific mass transfer strategies.
This class defines the interface for various condensation models
used in atmospheric physics. Subclasses should implement specific
condensation algorithms based on different physical models and equations.
Args:
molar_mass: The molar mass of the species [kg/mol]. If a single value
Expand Down

0 comments on commit 2bc9671

Please sign in to comment.