diff --git a/README.md b/README.md index 2cdeb6eea..5b1a3bf29 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -# *PARTICULA* +# Gorkowski/PARTICULA + +This repository is a development fork of `Particula`. Since this is an active development environment, the codebase may undergo frequent changes, and instability can occur. To install this version directly, use the following `pip` command: + +```bash +pip install git+https://github.com/Gorkowski/particula.git +``` + +# PARITCULA Particula is a simple aerosol particle simulator. It 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 in experiments and research endeavors.