dmsan 0.1.0

What is DMsan?

DMsan is 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 package QSDsan (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 package EXPOsan - exposition of sanitation and resource recovery systems, which can be used to develop sanitation and resource recovery alternatives for evaluation in DMsan.

Installation

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

pip install dmsan

If you need to upgrade:

pip install -U dmsan

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

pip install dmsan==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/DMsan.git

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 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 are a developer and want to contribute to QSDsan, please follow the steps in the Contributing to QSDsan section of the documentation to clone the repository. If you find yourself struggle with the installation of QSDsan/setting up the environment, this extended version of installation instructions might be helpful to you.

Documentation

You can find QSDsan tutorials and documents at:

https://qsdsan.readthedocs.io

All 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 our YouTube channel so subscribe to receive updates!

About the authors

Development and maintenance of the package is supported by the Quantitative Sustainable Design Group led by members of the Guest Group at the University of Illinois Urbana-Champaign (UIUC). Core contributors are listed below, please refer to the author page for the full list of authors.

Lead developers:

• Hannah Lohman

• Tori Morgan

• Yalin Li (current maintainer)

• Joy Zhang

Project conception & funding support:

• Jeremy Guest

Contributing

Please refer to the Contributing to QSDsan section of the documentation for instructions and guidelines.

Stay Connected

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 this 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).

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