Package: dmsan
ContentsWhat isDMsan?InstallationDocumentationAbout the authorsContributingStay ConnectedQSDsan EventsLicense informationReferencesWhat isDMsan?DMsanis an open-source platform for decision-making for 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].As an open-source multi-criteria decision analysis platform, DMsan enables users to transparently compare sanitation and resource recovery alternatives and characterize the opportunity space for early-stage technologies using multiple dimensions of sustainability with consideration of location-specific contextual parameters.DMsan integrates with the open-source Python packageQSDsan(the quantitative sustainable design (QSD) of sanitation and resource recovery systems) for system design and simulation to calculate quantitative economic (via techno-economic analysis, TEA), environmental (via life cycle assessment, LCA), and resource recovery indicators under uncertainty[2].All systems developed with QSDsan are included in the packageEXPOsan- exposition of sanitation and resource recovery systems, which can be used to develop sanitation and resource recovery alternatives for evaluation in DMsan.InstallationThe easiest way is throughpip, in command-line interface (e.g., Anaconda prompt, terminal):pip install dmsanIf you need to upgrade:pip install -U dmsanor for a specific version (replace X.X.X with the version number):pip install dmsan==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/DMsan.gitNoteIf this doesn’t give you the newestdmsan, trypip uninstall dmsanfirst.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>/DMsan.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 are a developer and want to contribute toQSDsan, please follow the steps in theContributing to QSDsansection 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 QSDsan tutorials and documents at:https://qsdsan.readthedocs.ioAll tutorials are written using Jupyter Notebook, you can run your own Jupyter environment.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 authorsDevelopment and maintenance of the package is supported by the Quantitative Sustainable Design Group led by members of theGuest Groupat theUniversity of Illinois Urbana-Champaign (UIUC). Core contributors are listed below, please refer to theauthor pagefor the full list of authors.Lead developers:Hannah LohmanTori MorganYalin Li(current maintainer)Joy ZhangProject conception & funding support:Jeremy GuestContributingPlease refer to theContributing to QSDsansection 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.; 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.[2]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.