SwolfPy

A free, multi-platform, Python-based, open-source, SWM LCA optimization framework with built-in parametric and Monte Carlo sensitivity and uncertainty analysis capabilities.
https://github.com/swolfpy-project/swolfpy

Category: Industrial Ecology
Sub Category: Circular Economy and Waste

Keywords

brightway2 life-cycle-assessment monte-carlo-simulation municipal-solid-waste optimization pyside2 python solid-waste-management swolfpy uncertainty-assessment

Keywords from Contributors

composting landfill

Last synced: about 1 hour ago
JSON representation

Repository metadata

SwolfPy is a free, multi-platform, Python-based, open-source, SWM LCA optimization framework with built-in parametric and Monte Carlo sensitivity and uncertainty analysis capabilities.

• Host: GitHub
• URL: https://github.com/swolfpy-project/swolfpy
• Owner: SwolfPy-Project
• License: gpl-2.0
• Created: 2021-08-13T21:34:14.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-03-04T02:26:44.000Z (about 1 year ago)
• Last Synced: 2025-04-10T05:38:18.035Z (17 days ago)
• Topics: brightway2, life-cycle-assessment, monte-carlo-simulation, municipal-solid-waste, optimization, pyside2, python, solid-waste-management, swolfpy, uncertainty-assessment
• Language: Python
• Homepage: https://swolfpy-project.github.io/
• Size: 17.1 MB
• Stars: 24
• Watchers: 3
• Forks: 8
• Open Issues: 0
• Releases: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.md
  • Authors: AUTHORS.rst

README.rst

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

        

---

Owner metadata

• Name: Solid Waste Optimization Life-cycle Framework in Python (SwolfPy)
• Login: SwolfPy-Project
• Email: [email protected]
• Kind: organization
• Description: SWM LCA optimization framework with built-in parametric and Monte Carlo sensitivity and uncertainty analysis capabilties.
• Website: swolfpy-project.github.io/
• Location: United States of America
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/89031688?v=4
• Repositories: 4
• Last ynced at: 2023-03-11T02:27:43.969Z
• Profile URL: https://github.com/SwolfPy-Project

---

GitHub Events

Total

• Watch event: 2
• Fork event: 1

Last Year

• Watch event: 2
• Fork event: 1

---

Committers metadata

Last synced: 7 days ago

Name	Email	Commits
Mojtaba Sardarmehni	m****2@n****u	422
Pedro Anchieta	p****a@g****m	87
mojtaba sardarmehni	4****m	73
msm_sardar	m****i@g****m	15
Mojtaba Sardarmehni	m****5@a****m	1

Committer domains:

• ascendanalytics.com: 1
• ncsu.edu: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/swolfpy-project/swolfpy

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 748 last-month
• Total dependent packages: 0
• Total dependent repositories: 1
• Total versions: 22
• Total maintainers: 1

---

Dependencies

Score: 11.407564949312402