EXPOsan: EXPOsition of Sanitation and Resource Recovery Systems

What is EXPOsan?

The EXPOsan package contains systems developed using the QSDsan package. A list of the developed systems is included in QSDsan's documentation. Please refer to the individual README files within each system module for loading instructions and exemplary results.

Installation

EXPOsan requires Python 3.12 or newer. The easiest way to install EXPOsan is through pip in a command-line interface (e.g., terminal, PowerShell, etc.):

pip install exposan

This installs the core package. A few optional features (e.g., routing optimization in the hap module) need extra packages. You can install complete dependencies with:

pip install exposan[complete]

or install the specific package named in the error message when you first hit a missing feature.

If you need to upgrade:

pip install -U exposan

or for a specific version (replace X.X.X with the version number):

pip install exposan==X.X.X

If you want to install the latest GitHub version at the main branch (note that you can still use the -U flag for upgrading):

pip install git+https://github.com/QSD-Group/EXPOsan.git

or other fork and/or branch (replace <USERNAME_OF_THE_FORK> and <BRANCH_NAME> with the desired fork and branch names)

pip install git+https://github.com/<USERNAME_OF_THE_FORK>/EXPOsan.git@<BRANCH_NAME>

You can also download the package from PyPI.

To get the git version (use the depth flag to choose how many commit histories you want to clone):

git clone https://github.com/QSD-Group/EXPOsan.git --depth=1

then navigate into the repository (cd EXPOsan) and install the required packages:

pip install -e ".[dev]"

Note

Using the depth flag will only clone the main branch by default, if there are other branches and you want them, then use the no-single-branch flag, i.e.

git clone https://github.com/<YOUR_USERNAME>/EXPOsan.git --depth=1 --no-single-branch

Authors and Contributing

EXPOsan and QSDsan are developed by the Quantitative Sustainable Design Group and the broader community. Yalin Li is the currently maintainer. See commit history for contributors who have contributed to the repository.

If you want to contribute to EXPOsan, please refer to the Contributing Guidelines section of the documentation for instructions and guidelines.

License information

Please refer to the LICENSE.txt for information on the terms & conditions for usage of this software, and a DISCLAIMER OF ALL WARRANTIES.