Package: qsdsan
ContentsWhat isQSDsan?InstallationDocumentationAbout the AuthorsContributingStay ConnectedQSDsan EventsLicense InformationReferencesWhat isQSDsan?QSDsanis an open-source, community-led platform for the quantitative sustainable design (QSD) of sanitation and resource recovery systems[1]. 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[2]. It leverages the structure and modules developed in theBioSTEAMplatform[3]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 withQSDsanare included in the packageEXPOsan- exposition of sanitation and resource recovery systems.Additionally, another package,DMsan(decision-making for sanitation and resource recovery systems), is being developed for decision-making among multiple dimensions of sustainability with consideration of location-specific contextual parameters.InstallationThe easiest way is throughpip, in command-line interface (e.g., Anaconda prompt, terminal):pip install qsdsanIf you need to upgrade:pip install -U qsdsanor for a specific version (replace X.X.X with the version number):pip install qsdsan==X.X.XIf you want to install the latest GitHub version at themain branch(note that you can still use the-Uflag for upgrading):pip install git+https://github.com/QSD-Group/QSDsan.gitNoteIf this doesn’t give you the newestqsdsan, trypip uninstall qsdsanfirst.Also, you may need to update someqsdsan’s dependency package (e.g., ‘biosteamandthermosteam) versions in order for the newqsdsanto 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>/QSDsan.git@<BRANCH_NAME>You can also download the package fromPyPI.Note that development of this package is currently under initial stage with limited backward compatibility, please feel free tosubmit an issuefor any questions regarding package upgrading.If you want to contribute toQSDsan, please follow the steps in theContributing Guidelinessection of the documentation to clone the repository. If you find yourself struggle with the installation of QSDsan/setting up the environment, this extended version ofinstallation instructionsmight be helpful to you.DocumentationYou can find tutorials and documents at:https://qsdsan.readthedocs.ioAll tutorials are written using Jupyter Notebook, you can run your own Jupyter environment, or you can click thelaunch binderbadge 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 ourYouTube channelso subscribe to receive updates!About the AuthorsPlease refer toContributorssection for a list of contributors.ContributingPlease refer to theContributing Guidelinessection of the documentation for instructions and guidelines.Stay ConnectedIf you would like to receive news related to the QSDsan platform, you can subscribe to email updates usingthis form(don’t worry, you will be able to unsubscribe :)). Thank you in advance for your interest!QSDsan EventsWe will keep thiscalendarup-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).License InformationPlease refer to theLICENSE.txtfor information on the terms & conditions for usage of this software, and a DISCLAIMER OF ALL WARRANTIES.References[1]Li, Y.; Zhang, X.; Morgan, V.L.; Lohman, H.A.C.; Rowles, L.S.; Mittal, S.; Kogler, A.; Cusick, R.D.; Tarpeh, W.A.; Guest, J.S. QSDsan: An integrated platform for quantitative sustainable design of sanitation and resource recovery systems. Environ. Sci.: Water Res. Technol. 2022, 8 (10), 2289-2303.https://doi.org/10.1039/d2ew00455k.[2]Li, Y.; Trimmer, J.T.; Hand, S.; Zhang, X.; Chambers, K.G.; Lohman, H.A.C.; Shi, R.; Byrne, D.M.; Cook, S.M.; Guest, J.S. Quantitative Sustainable Design (QSD): A Methodology for the Prioritization of Research, Development, and Deployment of Technologies. (Tutorial Review) Environ. Sci.: Water Res. Technol. 2022, 8 (11), 2439–2465.https://doi.org/10.1039/D2EW00431C.[3]Cortés-Peña, Y.; Kumar, D.; Singh, V.; Guest, J.S. BioSTEAM: A Fast and Flexible Platform for the Design, Simulation, and Techno-Economic Analysis of Biorefineries under Uncertainty. ACS Sustainable Chem. Eng. 2020, 8 (8), 3302–3310.https://doi.org/10.1021/acssuschemeng.9b07040.