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

The easiest way is through pip, in your command-line interface (e.g., Anaconda prompt, terminal):

pip install exposan

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

Note

If this doesn't give you the newest exposan, try pip uninstall exposan first.

Also, you may need to update some exposan's dependency package (e.g., ' qsdsan, biosteam, thermosteam) versions in order for the new exposan to run.

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 –r requirements.txt

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 is developed by the Quantitative Sustainable Design Group led by members of the Guest Group and other developers that have contributed to the repository. Yalin Li) is the currently maintainer of this repository and package.

Please refer to the Contributing to QSDsan section of the documentation for instructions and guidelines. If you find yourself struggle with the installation/setting up the environment, this extended version of installation instructions might be helpful to you.

Stay Connected

If you would like to receive exciting news related to the QSDsan platform, you can subscribe to email updates using this form (don't worry, you will be able to unsubscribe :)). Thank you in advance for your interest!

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.