.. General
================================================================
Solid Waste Optimization Life-cycle Framework in Python(SwolfPy)
================================================================
.. image:: https://img.shields.io/pypi/v/swolfpy.svg
:target: https://pypi.python.org/pypi/swolfpy
.. image:: https://img.shields.io/pypi/pyversions/swolfpy.svg
:target: https://pypi.org/project/swolfpy/
:alt: Supported Python Versions
.. image:: https://img.shields.io/pypi/l/swolfpy.svg
:target: https://pypi.org/project/swolfpy/
:alt: License
.. image:: https://img.shields.io/pypi/dm/swolfpy.svg?label=Pypi%20downloads
:target: https://pypi.org/project/swolfpy/
:alt: Downloads
.. image:: https://img.shields.io/pypi/format/swolfpy.svg
:target: https://pypi.org/project/swolfpy/
:alt: Format
.. image:: https://readthedocs.org/projects/swolfpy/badge/?version=latest
:target: https://swolfpy.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://github.com/SwolfPy-Project/swolfpy/actions/workflows/python-app.yml/badge.svg?branch=master
:target: https://github.com/SwolfPy-Project/swolfpy/actions/workflows/python-app.yml
:alt: Test
.. image:: https://zenodo.org/badge/395802952.svg
:target: https://zenodo.org/badge/latestdoi/395802952
:alt: DOi
.. image:: https://img.shields.io/badge/JIE%20DOI-10.1111%2Fjiec.13236-blue
:target: https://doi.org/10.1111/jiec.13236
:alt: JIE DOI
* Free software: GNU GENERAL PUBLIC LICENSE V2
* Website: https://swolfpy-project.github.io
* Documentation: https://swolfpy.readthedocs.io
* Repository: https://github.com/SwolfPy-Project/swolfpy
Features
--------
* **Life-cycle assessment of Municipal Solid Waste (MSW) systems**
* Comparative LCA
* Contribution analysis
* LCI report
* **Monte Carlo simulation**
* Uncertainty analysis
* Data visualization (distributions & correlations)
* **Optimization**
* Minimize environmental burdens or cost subject to a number of technical or policy-related constraints
.. list-table:: **Life-cycle process models**
:widths: auto
:header-rows: 1
* -
- Process model
- Description
* - 1
- Landfill (**LF**)
- Calculates emissions, material use, and energy use associated with construction, operations,
closure and post-closure activities, landfill gas and leachate management, and carbon storage.
* - 2
- Waste-to-Energy (**WTE**)
- Calculates emissions, mass flows, and resource use and recovery for the mass burn WTE process.
* - 3
- Gasification & Syngas Combustion (**GC**)
- Calculates emissions, mass flows, and resource use and recovery for the GC process (Produced syngas from
gasification is combusted to produce electricity by steam turbine).
* - 4
- Composting (**Comp**)
- Calculates emissions, mass flows, and resource use and recovery for aerobic composting process and final use of compost.
* - 5
- Home Composting (**HC**)
- Calculates emissions, mass flows, and resource use and recovery for home composting process and final use of compost.
* - 6
- Anaerobic Digestion (**AD**)
- Calculates emissions, mass flows, and resource use and recovery for anaerobic digestion process and final use of compost.
* - 7
- Single-Stream Material Recovery facility (**SS_MRF**)
- Calculates cost, emissions, and energy use associated with material recovery facilities.
* - 8
- Refuse-Derived Fuel (**RDF**)
- Calculates cost, emissions, and energy use associated with RDF production facilities.
* - 9
- Reprocessing (**Reproc**)
- Calculates emissions, mass flows, and resource use and recovery associated with recycling materials.
* - 10
- Transfer Station (**TS**)
- Calculates cost, emissions, and energy use associated with Transfer Stations.
* - 11
- Single Family Collection (**SF_Col**)
- Calculates cost, emissions, and fossil fuel use associated with MSW collection from single family sector.
* - 12
- Multi Family Collection (**MF_Col**)
- Calculates cost, emissions, and fossil fuel use associated with MSW collection from multi-family sector.
* - 13
- Commercial Collection (**COM_Col**)
- Calculates cost, emissions, and fossil fuel use associated with MSW collection from commercial sector.
* - 14
- Animal Feed (**AnF**)
- Calculates cost, emissions, and energy use associated with conversion of food waste to animal feed and final use of produced feed.
.. Installation
Installation
------------
1- Download and install miniconda from: https://docs.conda.io/en/latest/miniconda.html
2- Update conda in a terminal window or anaconda prompt::
conda update conda
3- Create a new environment for swolfpy::
conda create --name swolfpy python=3.9 graphviz
4- Add Graphviz executables to your system PATH (This step is optional; Enables plotting SWM network). You can find Graphviz executables in ``\\miniconda3\\envs\\swolfpy\\Library\\bin\\graphviz`` folder or search for ``dot.exe`` file in your system. Add the directory to the ``Path`` variable in your environment variables.
5- Activate the environment::
conda activate swolfpy
6- Install swolfpy in the environment::
pip install swolfpy
7- Open python to run swolfpy::
python
8- Run swolfpy
- In terminal::
swolfpy
# or
python -m swolfpy
- In python::
import swolfpy as sp
sp.SwolfPy()
.. endInstallation
=======
History
=======
1.4.0 (2024-03-02)
------------------
* Pin the version of scipy to 1.8.0 to avoid inexact indices changed from a deprecation to raising an error in 1.9
* Fix sphinx warnings
1.3.0 (2024-02-20)
------------------
* Add entry point for the GUI (run swolfpy in terminal)
1.2.0 (2023-07-30)
------------------
* Downgrade to Python 3.9
1.0.0 (2023-06-03)
------------------
* Upgrade to Python 3.10
* Add PreCommit
0.2.5 (2022-04-07)
------------------
* Minor changes in optimization and GUI
0.2.3 (2021-11-16)
------------------
* Improve data validation in GUI
* Improve warning/Pop-ups
0.2.2 (2021-10-02)
------------------
* Add Home Composting (HC)
* Add Gasification & Syngas combustion (GC)
* Add Refuse-derived fuel (RDF)
0.2.0 (2021-05-10)
------------------
* Add tab for correlation analysis.
* Add cost calculations.
* Add help to interface.
* Parallel optimization.
0.1.8 (2020-05-20)
------------------
* Add tab for Monte Carlo results analysis.
* Show Sankey for mass flows after optimization.
* Show SWM Network graph.
0.1.6 (2020-04-11)
------------------
* Add Reprocessing.
* Revise Functional units.
* Revise parameters class.
0.1.0 (2020-02-27)
------------------
* First release on PyPI.
* Main functionality: LCA, Monte-Carlo, and Optimization.
* Process Models include LF, WTE, Composting, AD, SS_MRF, and Collection.
Raw data
{
"_id": null,
"home_page": "",
"name": "swolfpy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Mojtaba Sardarmehni <msardar2@alumni.ncsu.edu>",
"keywords": "LCA,solid_waste,waste_management,swolfpy,brightway2",
"author": "",
"author_email": "Mojtaba Sardarmehni <msardar2@alumni.ncsu.edu>",
"download_url": "https://files.pythonhosted.org/packages/50/75/6df90dae95791c9a2d4d894c59ffc9d330d67102a4086a2d2ec9cfe8a0a5/swolfpy-1.4.0.tar.gz",
"platform": null,
"description": ".. General\r\n\r\n================================================================\r\nSolid Waste Optimization Life-cycle Framework in Python(SwolfPy)\r\n================================================================\r\n\r\n.. image:: https://img.shields.io/pypi/v/swolfpy.svg\r\n :target: https://pypi.python.org/pypi/swolfpy\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/swolfpy.svg\r\n :target: https://pypi.org/project/swolfpy/\r\n :alt: Supported Python Versions\r\n\r\n.. image:: https://img.shields.io/pypi/l/swolfpy.svg\r\n :target: https://pypi.org/project/swolfpy/\r\n :alt: License\r\n\r\n.. image:: https://img.shields.io/pypi/dm/swolfpy.svg?label=Pypi%20downloads\r\n :target: https://pypi.org/project/swolfpy/\r\n :alt: Downloads\r\n\r\n.. image:: https://img.shields.io/pypi/format/swolfpy.svg\r\n :target: https://pypi.org/project/swolfpy/\r\n :alt: Format\r\n\r\n.. image:: https://readthedocs.org/projects/swolfpy/badge/?version=latest\r\n :target: https://swolfpy.readthedocs.io/en/latest/?badge=latest\r\n :alt: Documentation Status\r\n\r\n.. image:: https://github.com/SwolfPy-Project/swolfpy/actions/workflows/python-app.yml/badge.svg?branch=master\r\n :target: https://github.com/SwolfPy-Project/swolfpy/actions/workflows/python-app.yml\r\n :alt: Test\r\n\r\n.. image:: https://zenodo.org/badge/395802952.svg\r\n :target: https://zenodo.org/badge/latestdoi/395802952\r\n :alt: DOi\r\n\r\n.. image:: https://img.shields.io/badge/JIE%20DOI-10.1111%2Fjiec.13236-blue\r\n :target: https://doi.org/10.1111/jiec.13236\r\n :alt: JIE DOI\r\n\r\n* Free software: GNU GENERAL PUBLIC LICENSE V2\r\n* Website: https://swolfpy-project.github.io\r\n* Documentation: https://swolfpy.readthedocs.io\r\n* Repository: https://github.com/SwolfPy-Project/swolfpy\r\n\r\n\r\nFeatures\r\n--------\r\n\r\n* **Life-cycle assessment of Municipal Solid Waste (MSW) systems**\r\n\r\n * Comparative LCA\r\n * Contribution analysis\r\n * LCI report\r\n\r\n* **Monte Carlo simulation**\r\n\r\n * Uncertainty analysis\r\n * Data visualization (distributions & correlations)\r\n\r\n* **Optimization**\r\n\r\n * Minimize environmental burdens or cost subject to a number of technical or policy-related constraints\r\n\r\n\r\n.. list-table:: **Life-cycle process models**\r\n :widths: auto\r\n :header-rows: 1\r\n\r\n * -\r\n - Process model\r\n - Description\r\n * - 1\r\n - Landfill (**LF**)\r\n - Calculates emissions, material use, and energy use associated with construction, operations,\r\n closure and post-closure activities, landfill gas and leachate management, and carbon storage.\r\n * - 2\r\n - Waste-to-Energy (**WTE**)\r\n - Calculates emissions, mass flows, and resource use and recovery for the mass burn WTE process.\r\n * - 3\r\n - Gasification & Syngas Combustion (**GC**)\r\n - Calculates emissions, mass flows, and resource use and recovery for the GC process (Produced syngas from\r\n gasification is combusted to produce electricity by steam turbine).\r\n * - 4\r\n - Composting (**Comp**)\r\n - Calculates emissions, mass flows, and resource use and recovery for aerobic composting process and final use of compost.\r\n * - 5\r\n - Home Composting (**HC**)\r\n - Calculates emissions, mass flows, and resource use and recovery for home composting process and final use of compost.\r\n * - 6\r\n - Anaerobic Digestion (**AD**)\r\n - Calculates emissions, mass flows, and resource use and recovery for anaerobic digestion process and final use of compost.\r\n * - 7\r\n - Single-Stream Material Recovery facility (**SS_MRF**)\r\n - Calculates cost, emissions, and energy use associated with material recovery facilities.\r\n * - 8\r\n - Refuse-Derived Fuel (**RDF**)\r\n - Calculates cost, emissions, and energy use associated with RDF production facilities.\r\n * - 9\r\n - Reprocessing (**Reproc**)\r\n - Calculates emissions, mass flows, and resource use and recovery associated with recycling materials.\r\n * - 10\r\n - Transfer Station (**TS**)\r\n - Calculates cost, emissions, and energy use associated with Transfer Stations.\r\n * - 11\r\n - Single Family Collection (**SF_Col**)\r\n - Calculates cost, emissions, and fossil fuel use associated with MSW collection from single family sector.\r\n * - 12\r\n - Multi Family Collection (**MF_Col**)\r\n - Calculates cost, emissions, and fossil fuel use associated with MSW collection from multi-family sector.\r\n * - 13\r\n - Commercial Collection (**COM_Col**)\r\n - Calculates cost, emissions, and fossil fuel use associated with MSW collection from commercial sector.\r\n * - 14\r\n - Animal Feed (**AnF**)\r\n - Calculates cost, emissions, and energy use associated with conversion of food waste to animal feed and final use of produced feed.\r\n\r\n\r\n.. Installation\r\n\r\nInstallation\r\n------------\r\n1- Download and install miniconda from: https://docs.conda.io/en/latest/miniconda.html\r\n\r\n2- Update conda in a terminal window or anaconda prompt::\r\n\r\n conda update conda\r\n\r\n3- Create a new environment for swolfpy::\r\n\r\n conda create --name swolfpy python=3.9 graphviz\r\n\r\n4- Add Graphviz executables to your system PATH (This step is optional; Enables plotting SWM network). You can find Graphviz executables in ``\\\\miniconda3\\\\envs\\\\swolfpy\\\\Library\\\\bin\\\\graphviz`` folder or search for ``dot.exe`` file in your system. Add the directory to the ``Path`` variable in your environment variables.\r\n\r\n5- Activate the environment::\r\n\r\n conda activate swolfpy\r\n\r\n6- Install swolfpy in the environment::\r\n\r\n pip install swolfpy\r\n\r\n7- Open python to run swolfpy::\r\n\r\n python\r\n\r\n8- Run swolfpy\r\n\r\n - In terminal::\r\n\r\n swolfpy\r\n # or\r\n python -m swolfpy\r\n\r\n - In python::\r\n\r\n import swolfpy as sp\r\n sp.SwolfPy()\r\n\r\n.. endInstallation\r\n\r\n=======\r\nHistory\r\n=======\r\n\r\n1.4.0 (2024-03-02)\r\n------------------\r\n\r\n* Pin the version of scipy to 1.8.0 to avoid inexact indices changed from a deprecation to raising an error in 1.9\r\n* Fix sphinx warnings\r\n\r\n1.3.0 (2024-02-20)\r\n------------------\r\n\r\n* Add entry point for the GUI (run swolfpy in terminal)\r\n\r\n\r\n1.2.0 (2023-07-30)\r\n------------------\r\n\r\n* Downgrade to Python 3.9\r\n\r\n\r\n\r\n1.0.0 (2023-06-03)\r\n------------------\r\n\r\n* Upgrade to Python 3.10\r\n* Add PreCommit\r\n\r\n\r\n0.2.5 (2022-04-07)\r\n------------------\r\n\r\n* Minor changes in optimization and GUI\r\n\r\n\r\n0.2.3 (2021-11-16)\r\n------------------\r\n\r\n* Improve data validation in GUI\r\n* Improve warning/Pop-ups\r\n\r\n\r\n0.2.2 (2021-10-02)\r\n------------------\r\n\r\n* Add Home Composting (HC)\r\n* Add Gasification & Syngas combustion (GC)\r\n* Add Refuse-derived fuel (RDF)\r\n\r\n\r\n0.2.0 (2021-05-10)\r\n------------------\r\n\r\n* Add tab for correlation analysis.\r\n* Add cost calculations.\r\n* Add help to interface.\r\n* Parallel optimization.\r\n\r\n\r\n\r\n0.1.8 (2020-05-20)\r\n------------------\r\n\r\n* Add tab for Monte Carlo results analysis.\r\n* Show Sankey for mass flows after optimization.\r\n* Show SWM Network graph.\r\n\r\n\r\n\r\n0.1.6 (2020-04-11)\r\n------------------\r\n\r\n* Add Reprocessing.\r\n* Revise Functional units.\r\n* Revise parameters class.\r\n\r\n\r\n0.1.0 (2020-02-27)\r\n------------------\r\n\r\n* First release on PyPI.\r\n* Main functionality: LCA, Monte-Carlo, and Optimization.\r\n* Process Models include LF, WTE, Composting, AD, SS_MRF, and Collection.\r\n",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSE V2",
"summary": "Solid Waste Optimization Life-cycle Framework in Python(SwolfPy).",
"version": "1.4.0",
"project_urls": {
"Documentation": "https://swolfpy.readthedocs.io/en/latest/",
"Homepage": "https://swolfpy-project.github.io/",
"Source Code": "https://github.com/SwolfPy-Project/swolfpy"
},
"split_keywords": [
"lca",
"solid_waste",
"waste_management",
"swolfpy",
"brightway2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "913595394137174fa174d81fb259a5b52032fa4da72239bf223e1ffa255d1fb1",
"md5": "222cf88b1a78c6c3a26aabe916fe3131",
"sha256": "a578621027c05ca020df57f90ed869d5ac9637a67000f60705b8a3181f5acde0"
},
"downloads": -1,
"filename": "swolfpy-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "222cf88b1a78c6c3a26aabe916fe3131",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 603862,
"upload_time": "2024-03-03T17:40:59",
"upload_time_iso_8601": "2024-03-03T17:40:59.786493Z",
"url": "https://files.pythonhosted.org/packages/91/35/95394137174fa174d81fb259a5b52032fa4da72239bf223e1ffa255d1fb1/swolfpy-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "50756df90dae95791c9a2d4d894c59ffc9d330d67102a4086a2d2ec9cfe8a0a5",
"md5": "58042860b0fb3498114a9cc8f8127ac7",
"sha256": "7964cb077ef1d62960d8b583b81741456ade829b91934a2fc9ca4c8d21f4b953"
},
"downloads": -1,
"filename": "swolfpy-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "58042860b0fb3498114a9cc8f8127ac7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6757984,
"upload_time": "2024-03-03T17:41:02",
"upload_time_iso_8601": "2024-03-03T17:41:02.242702Z",
"url": "https://files.pythonhosted.org/packages/50/75/6df90dae95791c9a2d4d894c59ffc9d330d67102a4086a2d2ec9cfe8a0a5/swolfpy-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-03 17:41:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SwolfPy-Project",
"github_project": "swolfpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "swolfpy"
}
JSON
