swolfpy-processmodels


Nameswolfpy-processmodels JSON
Version 1.1.0 PyPI version JSON
download
home_page
SummaryLife-Cylce Process Models for swolfpy (swolfpy_processmodels).
upload_time2023-07-30 16:19:03
maintainer
docs_urlNone
author
requires_python>=3.9
licenseGNU GENERAL PUBLIC LICENSE V2
keywords lca solid_waste waste_management swolfpy brightway2
VCS
bugtrack_url
requirements coverage jupyter numpy_financial pandas plotly pre-commit pylint pytest pytest-cov swolfpy_inputdata xlrd
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. General

==============================================================
Life-Cycle Process Models for SwolfPy (swolfpy_processmodels)
==============================================================

.. image:: https://img.shields.io/pypi/v/swolfpy_processmodels.svg
        :target: https://pypi.python.org/pypi/swolfpy_processmodels

.. image:: https://img.shields.io/pypi/pyversions/swolfpy_processmodels.svg
    :target: https://pypi.org/project/swolfpy_processmodels/
    :alt: Supported Python Versions

.. image:: https://img.shields.io/pypi/l/swolfpy_processmodels.svg
    :target: https://pypi.org/project/swolfpy_processmodels/
    :alt: License

.. image:: https://img.shields.io/pypi/dm/swolfpy-processmodels.svg?label=Pypi%20downloads
    :target: https://pypi.org/project/swolfpy-processmodels/
    :alt: Downloads

.. image:: https://img.shields.io/pypi/format/swolfpy_processmodels.svg
    :target: https://pypi.org/project/swolfpy_processmodels/
    :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-processmodels/actions/workflows/python-app.yml/badge.svg?branch=master
        :target: https://github.com/SwolfPy-Project/swolfpy-processmodels/actions/workflows/python-app.yml
        :alt: Test

.. image:: https://zenodo.org/badge/395802174.svg
        :target: https://zenodo.org/badge/latestdoi/395802174
        :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-processmodels


Features
--------
* Life-cycle process models for solid waste management (SWM) processes.
* Built-in Monte Carlo simulation

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

4- Activate the environment::

        conda activate swolfpy

5- Install swolfpy_processmodels in the environment::

        pip install swolfpy_processmodels

6- Use in python (e.g., Landfill model)::

        import swolfpy_processmodels as sppm
        model = sppm.LF()
        model.calc()
        LCI_report = model.report()
        LCI_report

.. endInstallation

=======
History
=======

1.1.0 (2023-07-30)
------------------

* Downgrade to Python 3.9


1.0.0 (2023-06-03)
------------------

* Upgrade to Python 3.10
* Add PreCommit


0.1.9 (2022-04-06)
------------------

* Add Multi-family and commercial Waste collection
* Add Animal feed production
* Refactor SF-collection model


0.1.8 (2021-11-25)
------------------

* Update Landfill model.


0.1.6 (2021-10-02)
------------------

* Add Home Composting (HC)
* Add Gasification & Syngas combustion (GC)
* Add Refuse-derived fuel (RDF)


0.1.4 (2021-05-10)
------------------

* New Life-cycle model: TS
* Add Cost calculations



0.1.0 (2020-05-06)
------------------

* First release on PyPI. Life-cycle process models include: LF, WTE, Composting, AD, SS_MRF, reprocessing and Collection.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "swolfpy-processmodels",
    "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/37/3f/04fc8c3b3a621ee5a750f74b48a5401bde526a906c52c755f66310307073/swolfpy_processmodels-1.1.0.tar.gz",
    "platform": null,
    "description": ".. General\r\n\r\n==============================================================\r\nLife-Cycle Process Models for SwolfPy (swolfpy_processmodels)\r\n==============================================================\r\n\r\n.. image:: https://img.shields.io/pypi/v/swolfpy_processmodels.svg\r\n        :target: https://pypi.python.org/pypi/swolfpy_processmodels\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/swolfpy_processmodels.svg\r\n    :target: https://pypi.org/project/swolfpy_processmodels/\r\n    :alt: Supported Python Versions\r\n\r\n.. image:: https://img.shields.io/pypi/l/swolfpy_processmodels.svg\r\n    :target: https://pypi.org/project/swolfpy_processmodels/\r\n    :alt: License\r\n\r\n.. image:: https://img.shields.io/pypi/dm/swolfpy-processmodels.svg?label=Pypi%20downloads\r\n    :target: https://pypi.org/project/swolfpy-processmodels/\r\n    :alt: Downloads\r\n\r\n.. image:: https://img.shields.io/pypi/format/swolfpy_processmodels.svg\r\n    :target: https://pypi.org/project/swolfpy_processmodels/\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-processmodels/actions/workflows/python-app.yml/badge.svg?branch=master\r\n        :target: https://github.com/SwolfPy-Project/swolfpy-processmodels/actions/workflows/python-app.yml\r\n        :alt: Test\r\n\r\n.. image:: https://zenodo.org/badge/395802174.svg\r\n        :target: https://zenodo.org/badge/latestdoi/395802174\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\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-processmodels\r\n\r\n\r\nFeatures\r\n--------\r\n* Life-cycle process models for solid waste management (SWM) processes.\r\n* Built-in Monte Carlo simulation\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.. 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\r\n\r\n4- Activate the environment::\r\n\r\n        conda activate swolfpy\r\n\r\n5- Install swolfpy_processmodels in the environment::\r\n\r\n        pip install swolfpy_processmodels\r\n\r\n6- Use in python (e.g., Landfill model)::\r\n\r\n        import swolfpy_processmodels as sppm\r\n        model = sppm.LF()\r\n        model.calc()\r\n        LCI_report = model.report()\r\n        LCI_report\r\n\r\n.. endInstallation\r\n\r\n=======\r\nHistory\r\n=======\r\n\r\n1.1.0 (2023-07-30)\r\n------------------\r\n\r\n* Downgrade to Python 3.9\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.1.9 (2022-04-06)\r\n------------------\r\n\r\n* Add Multi-family and commercial Waste collection\r\n* Add Animal feed production\r\n* Refactor SF-collection model\r\n\r\n\r\n0.1.8 (2021-11-25)\r\n------------------\r\n\r\n* Update Landfill model.\r\n\r\n\r\n0.1.6 (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.1.4 (2021-05-10)\r\n------------------\r\n\r\n* New Life-cycle model: TS\r\n* Add Cost calculations\r\n\r\n\r\n\r\n0.1.0 (2020-05-06)\r\n------------------\r\n\r\n* First release on PyPI. Life-cycle process models include: LF, WTE, Composting, AD, SS_MRF, reprocessing and Collection.\r\n",
    "bugtrack_url": null,
    "license": "GNU GENERAL PUBLIC LICENSE V2",
    "summary": "Life-Cylce Process Models for swolfpy (swolfpy_processmodels).",
    "version": "1.1.0",
    "project_urls": {
        "Documentation": "https://swolfpy.readthedocs.io/en/latest/",
        "Homepage": "https://swolfpy-project.github.io/",
        "Source Code": "https://github.com/SwolfPy-Project/swolfpy-processmodels"
    },
    "split_keywords": [
        "lca",
        "solid_waste",
        "waste_management",
        "swolfpy",
        "brightway2"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7e2ca5b263e8e0deaf47048152a15ae1596429550ce3a04c341539739ac60bc0",
                "md5": "70c83d157283bc15f8d81e78656d5dbf",
                "sha256": "edeed56b4979437484c629ccde6d3af215fb0a47604a70630ae060492075366c"
            },
            "downloads": -1,
            "filename": "swolfpy_processmodels-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "70c83d157283bc15f8d81e78656d5dbf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 90988,
            "upload_time": "2023-07-30T16:19:01",
            "upload_time_iso_8601": "2023-07-30T16:19:01.884193Z",
            "url": "https://files.pythonhosted.org/packages/7e/2c/a5b263e8e0deaf47048152a15ae1596429550ce3a04c341539739ac60bc0/swolfpy_processmodels-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "373f04fc8c3b3a621ee5a750f74b48a5401bde526a906c52c755f66310307073",
                "md5": "b57d0dea4e52e282a41ff8f6ab1bf3be",
                "sha256": "88da8c3e060086ef50bf3aaf3021040e7ea2957571097b2ab9577781a6a5c193"
            },
            "downloads": -1,
            "filename": "swolfpy_processmodels-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b57d0dea4e52e282a41ff8f6ab1bf3be",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 85704,
            "upload_time": "2023-07-30T16:19:03",
            "upload_time_iso_8601": "2023-07-30T16:19:03.730546Z",
            "url": "https://files.pythonhosted.org/packages/37/3f/04fc8c3b3a621ee5a750f74b48a5401bde526a906c52c755f66310307073/swolfpy_processmodels-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-30 16:19:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SwolfPy-Project",
    "github_project": "swolfpy-processmodels",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "coverage",
            "specs": []
        },
        {
            "name": "jupyter",
            "specs": []
        },
        {
            "name": "numpy_financial",
            "specs": []
        },
        {
            "name": "pandas",
            "specs": []
        },
        {
            "name": "plotly",
            "specs": []
        },
        {
            "name": "pre-commit",
            "specs": []
        },
        {
            "name": "pylint",
            "specs": []
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "pytest-cov",
            "specs": []
        },
        {
            "name": "swolfpy_inputdata",
            "specs": []
        },
        {
            "name": "xlrd",
            "specs": [
                [
                    "==",
                    "1.2.0"
                ]
            ]
        }
    ],
    "lcname": "swolfpy-processmodels"
}
        
Elapsed time: 0.20863s