===============================================================
EXPOsan: EXPOsition of Sanitation and Resource Recovery Systems
===============================================================
.. License
.. image:: https://img.shields.io/pypi/l/exposan?color=blue&logo=UIUC&style=flat
:target: https://github.com/QSD-Group/EXPOsan/blob/main/LICENSE.txt
.. Tested Python version
.. image:: https://img.shields.io/pypi/pyversions/exposan?style=flat
:target: https://pypi.python.org/pypi/exposan
.. PyPI version
.. image:: https://img.shields.io/pypi/v/exposan?style=flat&color=blue
:target: https://pypi.org/project/exposan
.. GitHub test of the main branch
.. image:: https://github.com/QSD-Group/EXPOsan/actions/workflows/build-latest.yml/badge.svg?branch=main
:target: https://github.com/QSD-Group/EXPOsan/actions/workflows/build-latest.yml
.. Code of Conduct
.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
:target: https://qsdsan.readthedocs.io/en/latest/CODE_OF_CONDUCT.html
.. AppVeyor test of the stable branch, not in active use
..
image:: https://img.shields.io/appveyor/build/yalinli2/EXPOsan/main?label=build-stable&logo=appveyor
:target: https://github.com/QSD-Group/EXPOsan/tree/stable
What is ``EXPOsan``?
--------------------
The ``EXPOsan`` package contains systems developed using the `QSDsan <https://github.com/QSD-Group/QSDsan>`_ package. A list of the developed systems is included in QSDsan's `documentation <https://qsdsan.readthedocs.io/en/latest/Developed_Systems.html>`_. Please refer to the individual README files within each system module for loading instructions and exemplary results.
Installation
------------
The easiest way is through ``pip``, in your command-line interface (e.g., Anaconda prompt, terminal):
.. code:: bash
pip install exposan
If you need to upgrade:
.. code::
pip install -U exposan
or for a specific version (replace X.X.X with the version number):
.. code::
pip install exposan==X.X.X
If you want to install the latest GitHub version at the `main branch <https://github.com/qsd-group/exposan>`_ (note that you can still use the ``-U`` flag for upgrading):
.. code::
pip install git+https://github.com/QSD-Group/EXPOsan.git
.. note::
If this doesn't give you the newest ``exposan``, try ``pip uninstall exposan`` first.
Also, you may need to update some ``exposan``'s dependency package (e.g., ' ``qsdsan``, ``biosteam``, ``thermosteam``) versions in order for the new ``exposan`` to run.
or other fork and/or branch (replace ``<USERNAME_OF_THE_FORK>`` and ``<BRANCH_NAME>`` with the desired fork and branch names)
.. code::
pip install git+https://github.com/<USERNAME_OF_THE_FORK>/EXPOsan.git@<BRANCH_NAME>
You can also download the package from `PyPI <https://pypi.org/project/exposan/>`_.
To get the git version (use the ``depth`` flag to choose how many commit histories you want to clone):
.. code:: bash
git clone https://github.com/QSD-Group/EXPOsan.git --depth=1
then navigate into the repository (``cd EXPOsan``) and install the required packages:
.. code:: bash
pip install –r requirements.txt
.. note::
Using the ``depth`` flag will only clone the main branch by default, if there are other branches and you want them, then use the ``no-single-branch`` flag, i.e.
.. code:: bash
git clone https://github.com/<YOUR_USERNAME>/EXPOsan.git --depth=1 --no-single-branch
Authors and Contributing
------------------------
``EXPOsan`` is developed by the Quantitative Sustainable Design Group led by members of the `Guest Group <http://engineeringforsustainability.com/>`_ and `other developers <https://github.com/QSD-Group/EXPOsan/graphs/contributors>`_ that have contributed to the repository. `Yalin Li <https://qsdsan.readthedocs.io/en/latest/authors/Yalin_Li.html>`_) is the currently maintainer of this repository and package.
Please refer to the `Contributing to QSDsan <https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html>`_ section of the documentation for instructions and guidelines. If you find yourself struggle with the installation/setting up the environment, this extended version of `installation instructions <https://qsdsan.readthedocs.io/en/latest/tutorials/_installation.html>`_ might be helpful to you.
Stay Connected
--------------
If you would like to receive exciting news related to the QSDsan platform, you can subscribe to email updates using `this form <https://groups.webservices.illinois.edu/subscribe/154591>`_ (don't worry, you will be able to unsubscribe :)). Thank you in advance for your interest!
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/QSD-Group/EXPOsan",
"name": "exposan",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "quantitative sustainable design,sanitation,resource recovery,techno-economic analysis,life cycle assessment",
"author": "Quantitative Sustainable Design Group",
"author_email": "quantitative.sustainable.design@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/37/40/72eab04cb89c9b0c6587f6e798f2fcc6849434e9ed633a81666b8fbe38f8/exposan-1.3.2.tar.gz",
"platform": null,
"description": "===============================================================\r\nEXPOsan: EXPOsition of Sanitation and Resource Recovery Systems\r\n===============================================================\r\n\r\n.. License\r\n.. image:: https://img.shields.io/pypi/l/exposan?color=blue&logo=UIUC&style=flat\r\n :target: https://github.com/QSD-Group/EXPOsan/blob/main/LICENSE.txt\r\n\r\n.. Tested Python version\r\n.. image:: https://img.shields.io/pypi/pyversions/exposan?style=flat\r\n :target: https://pypi.python.org/pypi/exposan\r\n\r\n.. PyPI version\r\n.. image:: https://img.shields.io/pypi/v/exposan?style=flat&color=blue\r\n :target: https://pypi.org/project/exposan\r\n\r\n.. GitHub test of the main branch\r\n.. image:: https://github.com/QSD-Group/EXPOsan/actions/workflows/build-latest.yml/badge.svg?branch=main\r\n :target: https://github.com/QSD-Group/EXPOsan/actions/workflows/build-latest.yml\r\n\r\n.. Code of Conduct\r\n.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg\r\n :target: https://qsdsan.readthedocs.io/en/latest/CODE_OF_CONDUCT.html\r\n\r\n.. AppVeyor test of the stable branch, not in active use\r\n..\r\n image:: https://img.shields.io/appveyor/build/yalinli2/EXPOsan/main?label=build-stable&logo=appveyor\r\n :target: https://github.com/QSD-Group/EXPOsan/tree/stable\r\n\r\n\r\nWhat is ``EXPOsan``?\r\n--------------------\r\nThe ``EXPOsan`` package contains systems developed using the `QSDsan <https://github.com/QSD-Group/QSDsan>`_ package. A list of the developed systems is included in QSDsan's `documentation <https://qsdsan.readthedocs.io/en/latest/Developed_Systems.html>`_. Please refer to the individual README files within each system module for loading instructions and exemplary results.\r\n\r\n\r\nInstallation\r\n------------\r\nThe easiest way is through ``pip``, in your command-line interface (e.g., Anaconda prompt, terminal):\r\n\r\n.. code:: bash\r\n\r\n pip install exposan\r\n\r\nIf you need to upgrade:\r\n\r\n.. code::\r\n\r\n pip install -U exposan\r\n\r\nor for a specific version (replace X.X.X with the version number):\r\n\r\n.. code::\r\n\r\n pip install exposan==X.X.X\r\n\r\nIf you want to install the latest GitHub version at the `main branch <https://github.com/qsd-group/exposan>`_ (note that you can still use the ``-U`` flag for upgrading):\r\n\r\n.. code::\r\n\r\n pip install git+https://github.com/QSD-Group/EXPOsan.git\r\n\r\n\r\n.. note::\r\n\r\n If this doesn't give you the newest ``exposan``, try ``pip uninstall exposan`` first.\r\n\r\n Also, you may need to update some ``exposan``'s dependency package (e.g., ' ``qsdsan``, ``biosteam``, ``thermosteam``) versions in order for the new ``exposan`` to run.\r\n\r\n\r\nor other fork and/or branch (replace ``<USERNAME_OF_THE_FORK>`` and ``<BRANCH_NAME>`` with the desired fork and branch names)\r\n\r\n.. code::\r\n\r\n pip install git+https://github.com/<USERNAME_OF_THE_FORK>/EXPOsan.git@<BRANCH_NAME>\r\n\r\n\r\nYou can also download the package from `PyPI <https://pypi.org/project/exposan/>`_.\r\n\r\n\r\nTo get the git version (use the ``depth`` flag to choose how many commit histories you want to clone):\r\n\r\n.. code:: bash\r\n\r\n git clone https://github.com/QSD-Group/EXPOsan.git --depth=1\r\n\r\nthen navigate into the repository (``cd EXPOsan``) and install the required packages:\r\n\r\n.. code:: bash\r\n\r\n pip install \u2013r requirements.txt\r\n\r\n\r\n.. note::\r\n \r\n Using the ``depth`` flag will only clone the main branch by default, if there are other branches and you want them, then use the ``no-single-branch`` flag, i.e.\r\n\r\n .. code:: bash\r\n\r\n git clone https://github.com/<YOUR_USERNAME>/EXPOsan.git --depth=1 --no-single-branch\r\n\r\n\r\nAuthors and Contributing\r\n------------------------\r\n``EXPOsan`` is developed by the Quantitative Sustainable Design Group led by members of the `Guest Group <http://engineeringforsustainability.com/>`_ and `other developers <https://github.com/QSD-Group/EXPOsan/graphs/contributors>`_ that have contributed to the repository. `Yalin Li <https://qsdsan.readthedocs.io/en/latest/authors/Yalin_Li.html>`_) is the currently maintainer of this repository and package.\r\n\r\nPlease refer to the `Contributing to QSDsan <https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html>`_ section of the documentation for instructions and guidelines. If you find yourself struggle with the installation/setting up the environment, this extended version of `installation instructions <https://qsdsan.readthedocs.io/en/latest/tutorials/_installation.html>`_ might be helpful to you.\r\n\r\n\r\nStay Connected\r\n--------------\r\nIf you would like to receive exciting news related to the QSDsan platform, you can subscribe to email updates using `this form <https://groups.webservices.illinois.edu/subscribe/154591>`_ (don't worry, you will be able to unsubscribe :)). Thank you in advance for your interest!\r\n\r\n\r\nLicense information\r\n-------------------\r\nPlease refer to the ``LICENSE.txt`` for information on the terms & conditions for usage of this software, and a DISCLAIMER OF ALL WARRANTIES.\r\n",
"bugtrack_url": null,
"license": "UIUC",
"summary": "Exposition of sanitation and resource recovery systems",
"version": "1.3.2",
"project_urls": {
"Documentation": "https://qsdsan.readthedocs.io",
"Homepage": "https://qsdsan.com",
"Repository": "https://github.com/QSD-Group/EXPOsan"
},
"split_keywords": [
"quantitative sustainable design",
"sanitation",
"resource recovery",
"techno-economic analysis",
"life cycle assessment"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3992f4a2bf073d36b80979ef67ff0a475f637952b7b64892c11c201e639e095c",
"md5": "4b8ed0c35841d5126944664173484810",
"sha256": "86bf8140ff57e17e235950d65a51293e2e4fa25da5075b9025fb471a04fb96b0"
},
"downloads": -1,
"filename": "exposan-1.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b8ed0c35841d5126944664173484810",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 898257,
"upload_time": "2023-10-23T02:08:05",
"upload_time_iso_8601": "2023-10-23T02:08:05.239679Z",
"url": "https://files.pythonhosted.org/packages/39/92/f4a2bf073d36b80979ef67ff0a475f637952b7b64892c11c201e639e095c/exposan-1.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "374072eab04cb89c9b0c6587f6e798f2fcc6849434e9ed633a81666b8fbe38f8",
"md5": "ac1770b9046a4c52327c1083e87447c7",
"sha256": "14848585a9202add2b601d4aeec8fbbc7cb19962dbb71b85b38152e859befbb8"
},
"downloads": -1,
"filename": "exposan-1.3.2.tar.gz",
"has_sig": false,
"md5_digest": "ac1770b9046a4c52327c1083e87447c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 868736,
"upload_time": "2023-10-23T02:08:07",
"upload_time_iso_8601": "2023-10-23T02:08:07.357741Z",
"url": "https://files.pythonhosted.org/packages/37/40/72eab04cb89c9b0c6587f6e798f2fcc6849434e9ed633a81666b8fbe38f8/exposan-1.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-23 02:08:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "QSD-Group",
"github_project": "EXPOsan",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "exposan"
}
JSON
