Quantitative Sustainable Design for sanitation and resource recovery systems
Project description
What is QSDsan?
QSDsan is an open-source, community-led platform for the quantitative sustainable design (QSD) of sanitation and resource recovery systems. It is one of a series of platforms that are being developed for the execution of QSD - a methodology for the research, design, and deployment of technologies and inform decision-making [1]. It leverages the structure and modules developed in the BioSTEAM platform [2] with additional functions tailored to sanitation processes.
As an open-source and impact-driven platform, QSDsan aims to identify configuration combinations, systematically probe interdependencies across technologies, and identify key sensitivities to contextual assumptions through the use of quantitative sustainable design methods (techno-economic analysis and life cycle assessment and under uncertainty).
All systems developed with QSDsan are included in the package EXPOsan - exposition of sanitation and resource recovery systems.
Installation
The easiest way is through pip, in command/Anaconda prompt (Windows) or terminal (macOS):
pip install qsdsan
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.
If you prefer the most recent version on GitHub, please follow the steps in the Contributing to QSDsan section of the documentation.
Documentation
You can find tutorials and documents at:
All tutorials are written using Jupyter Notebook, you can run your own Jupyter environment, or you can click the launch binder badge on the top to launch the environment in your browser.
For each of these tutorials, we are also recording videos where one of the QSD group members will go through the tutorial step-by-step. We are gradually releasing these videos on our YouTube channel so subscribe to receive updates!
Additionally, we are actively developing education modules for QSDsan (and other libraries/packages developed by the QSD group, you can find them in the QSDedu repository).
Contributing
Please refer to the Contributing to QSDsan 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.
References
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.