Skip to content

Python Editable Chemical Atmospheric Numeric Solver

Notifications You must be signed in to change notification settings

joshua-laughner/PECANS

Repository files navigation

PECANS

Python Editable Chemical Atmospheric Numeric Solver

DOI

Getting started

To install, simply download or clone this repo to your computer and install the requirements described in requirements.txt using pip install -r requirements.txt (called in the top directory of this repo, where requirements.txt is). I recommend installing in a virtual environment or Conda environment to avoid dependency conflicts with your base Python installation.

PECANS is currently built for Python 3.11. If you do not have Python 3.11 yet, see the installation section of the documentation for suggestions on how to install it.

PECANS can also be installed as a package by running python setup.py install or python setup.py develop in the top directory. This allows you to, for example, import PECANS into a Jupyter notebook. The difference between the install and develop commands is that the latter will link to the copy of the repo downloaded, so that if you pull updates or otherwise change the code, those changes will automatically be available to the package without needed to rerun the setup command.

Documentation

Full documentation is available at https://pecans.readthedocs.io/en/latest/.

Citing

The DOI in the badge at the top of this document will reference the most recent version of PECANS. Specific versions available are: