QSDsan: Quantitative Sustainable Design for Sanitation and Resource Recovery Systems#

What is QSDsan?#

QSDsan is an open-source, community-led platform for the quantitative sustainable design (QSD) [1] of sanitation and resource recovery systems [2]. It leverages existing platforms such as BioSTEAM [3] with enhanced features tailored to sanitation an resource recovery technologies. Through the integration with DMsan (decision-making for sanitation and resource recovery systems), this platform can be used to guide the research, development, and deployment (RD&D) of early-stage technologies considering location-specific parameters and stakeholder priorities.

Tutorials
_images/tutorials_icon.svg
API
_images/api_icon.svg
Systems
_images/systems_icon.svg
FAQ
_images/faq_icon.svg

Installation#

If you are new to Python, we are developing beginner tutorials with step-to-step guidance starting from setting up your Python environment.

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

pip install qsdsan

If you need to update:

pip install -U qsdsan

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

pip install qsdsan==X.X.X

If you want to install the latest GitHub version at the main branch:

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

You can also download the package from PyPI.

Note that development of this package is currently under initial stage with limited backward compatibility, please feel free to submit an issue for any questions regarding package upgrading.

Join the Community#

We would like to build an open and welcoming community, you can always post issues on our GitHub homepage or contact any of the Quantitative Sustainable Design Group members. We are always excited to have new members in our team.

If you would like to contribute, please follow our Contributing Guidelines and the Code of Conduct (a bonus if you use our templates), thank you for making QSDsan better!

QSDsan is and will stay open source under University of Illinois/NCSA Open Source License. Any third-party packages copied from QSDsan must be strictly open-source (not copy-left nor open-access). Please refer to the license page for details.

If you would like to receive 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!

QSDsan Events#

We will keep the calendar up-to-date as we organize more events (office hours, workshops, etc.), click on the events in the calendar to see the details (including meeting links).

References#