.. General
======================================================================
Input data for swolfpy's life-cycle process models (swolfpy_inputdata)
======================================================================
.. image:: https://img.shields.io/pypi/v/swolfpy_inputdata.svg
:target: https://pypi.python.org/pypi/swolfpy_inputdata
.. image:: https://img.shields.io/pypi/pyversions/swolfpy_inputdata.svg
:target: https://pypi.org/project/swolfpy_inputdata/
:alt: Supported Python Versions
.. image:: https://img.shields.io/pypi/l/swolfpy_inputdata.svg
:target: https://pypi.org/project/swolfpy_inputdata/
:alt: License
.. image:: https://img.shields.io/pypi/dm/swolfpy-inputdata.svg?label=Pypi%20downloads
:target: https://pypi.org/project/swolfpy-inputdata/
:alt: Downloads
.. image:: https://img.shields.io/pypi/format/swolfpy_inputdata.svg
:target: https://pypi.org/project/swolfpy_inputdata/
:alt: Format
.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen
:target: https://github.com/PyCQA/pylint
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
.. 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-inputdata/actions/workflows/python-app.yml/badge.svg?branch=master
:target: https://github.com/SwolfPy-Project/swolfpy-inputdata/actions/workflows/python-app.yml
:alt: Test
.. image:: https://zenodo.org/badge/395800995.svg
:target: https://zenodo.org/badge/latestdoi/395800995
: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-inputdata
Features
--------
* Input data for Life-cycle process models of swolfpy
* Common data (e.g., molecular weights, heating values)
* Material properties (46 common waste fractions; e.g., Food waste, Yard waste)
* Chemical properties (e.g., carbon content, methane yield)
* Physical properties (e.g., moisture content, density)
* Material dependent process model inputs (e.g., separation efficiency for each waste fraction in the trommel)
* Material indepent process model inputs
* Built-in Monte Carlo simulation
.. list-table:: **Description of columns in the csv file for input data**
:widths: auto
:header-rows: 1
* - Field
- Description
* - Category
- Category of the input (e.g., energy recovery, post closure)
* - Dictonary_Name
- Name of the dictionary and attribute (whitespace is not allowed)
* - Parameter Name
- Short name of the parameter (whitespace is not allowed)
* - Parameter Description
- Longer description of the parameter
* - Amount
- Default value for the parameter
* - Unit
- Unit of the parameter (e.g., MJ/Mg, kW, hours/day)
* - Uncertainty_type
- 0: Undefined, 2: Lognormal, 3: normal, 4: Uniform, 5: Triangular, 7: Discrete Uniform
* - Loc
- Mean for lognormal and normal distribution
* - scale
- Standard deviation for lognormal and normal distribution
* - shape
- Shape parameter for Weibull, Gamma or Beta distributions
* - Minimum
- Lower bound/minimum for lognormal, normal, uniform, triangular, and discrete uniform distributions
* - maximum
- Upper bound/maximum for lognormal, normal, uniform, triangular, and discrete uniform distributions
* - Reference
-
* - Comment
-
.. 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_inputdata in the environment::
pip install swolfpy_inputdata
6- Use in python (e.g., Landfill model)::
import swolfpy_inputdata as spid
data = spid.LF_Input()
model.calc()
#Example: Returs the actk parameter in landfill
data.LF_gas['actk']
#Example: Returns input data in dataframe format
data.Data
.. 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.2.4 (2022-04-05)
------------------
* Add Multi-family and commercial Waste collection
* Add Animal feed production (AnF)
0.2.3 (2021-11-24)
------------------
* Update Landfill
0.2.1 (2021-10-02)
------------------
* New models: Gasification & Syngas combustion (GC), Refuse-Derived Fuel (RDF), Home composting (HC)
0.1.9 (2021-05-10)
------------------
* Life cycle cost, input data for TS, References
0.1.0 (2020-05-06)
------------------
* First release on PyPI. Data for the Life-cycle process models include: LF, WTE, Composting, AD, SS_MRF, reprocessing and Collection.
Raw data
{
"_id": null,
"home_page": "",
"name": "swolfpy-inputdata",
"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/23/3e/36e290925043b4c9587afc132255a536b1a5bfb5283bf76615bba60aa825/swolfpy_inputdata-1.1.0.tar.gz",
"platform": null,
"description": ".. General\r\n\r\n======================================================================\r\nInput data for swolfpy's life-cycle process models (swolfpy_inputdata)\r\n======================================================================\r\n\r\n.. image:: https://img.shields.io/pypi/v/swolfpy_inputdata.svg\r\n :target: https://pypi.python.org/pypi/swolfpy_inputdata\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/swolfpy_inputdata.svg\r\n :target: https://pypi.org/project/swolfpy_inputdata/\r\n :alt: Supported Python Versions\r\n\r\n.. image:: https://img.shields.io/pypi/l/swolfpy_inputdata.svg\r\n :target: https://pypi.org/project/swolfpy_inputdata/\r\n :alt: License\r\n\r\n.. image:: https://img.shields.io/pypi/dm/swolfpy-inputdata.svg?label=Pypi%20downloads\r\n :target: https://pypi.org/project/swolfpy-inputdata/\r\n :alt: Downloads\r\n\r\n.. image:: https://img.shields.io/pypi/format/swolfpy_inputdata.svg\r\n :target: https://pypi.org/project/swolfpy_inputdata/\r\n :alt: Format\r\n\r\n.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen\r\n :target: https://github.com/PyCQA/pylint\r\n\r\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\r\n :target: https://github.com/ambv/black\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-inputdata/actions/workflows/python-app.yml/badge.svg?branch=master\r\n :target: https://github.com/SwolfPy-Project/swolfpy-inputdata/actions/workflows/python-app.yml\r\n :alt: Test\r\n\r\n.. image:: https://zenodo.org/badge/395800995.svg\r\n :target: https://zenodo.org/badge/latestdoi/395800995\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-inputdata\r\n\r\n\r\n\r\nFeatures\r\n--------\r\n* Input data for Life-cycle process models of swolfpy\r\n\r\n * Common data (e.g., molecular weights, heating values)\r\n * Material properties (46 common waste fractions; e.g., Food waste, Yard waste)\r\n\r\n * Chemical properties (e.g., carbon content, methane yield)\r\n * Physical properties (e.g., moisture content, density)\r\n * Material dependent process model inputs (e.g., separation efficiency for each waste fraction in the trommel)\r\n * Material indepent process model inputs\r\n\r\n* Built-in Monte Carlo simulation\r\n\r\n\r\n.. list-table:: **Description of columns in the csv file for input data**\r\n :widths: auto\r\n :header-rows: 1\r\n\r\n * - Field\r\n - Description\r\n * - Category\r\n - Category of the input (e.g., energy recovery, post closure)\r\n * - Dictonary_Name\r\n - Name of the dictionary and attribute (whitespace is not allowed)\r\n * - Parameter Name\r\n - Short name of the parameter (whitespace is not allowed)\r\n * - Parameter Description\r\n - Longer description of the parameter\r\n * - Amount\r\n - Default value for the parameter\r\n * - Unit\r\n - Unit of the parameter (e.g., MJ/Mg, kW, hours/day)\r\n * - Uncertainty_type\r\n - 0: Undefined, 2: Lognormal, 3: normal, 4: Uniform, 5: Triangular, 7: Discrete Uniform\r\n * - Loc\r\n - Mean for lognormal and normal distribution\r\n * - scale\r\n - Standard deviation for lognormal and normal distribution\r\n * - shape\r\n - Shape parameter for Weibull, Gamma or Beta distributions\r\n * - Minimum\r\n - Lower bound/minimum for lognormal, normal, uniform, triangular, and discrete uniform distributions\r\n * - maximum\r\n - Upper bound/maximum for lognormal, normal, uniform, triangular, and discrete uniform distributions\r\n * - Reference\r\n -\r\n * - Comment\r\n -\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\r\n\r\n4- Activate the environment::\r\n\r\n conda activate swolfpy\r\n\r\n5- Install swolfpy_inputdata in the environment::\r\n\r\n pip install swolfpy_inputdata\r\n\r\n6- Use in python (e.g., Landfill model)::\r\n\r\n import swolfpy_inputdata as spid\r\n data = spid.LF_Input()\r\n model.calc()\r\n #Example: Returs the actk parameter in landfill\r\n data.LF_gas['actk']\r\n #Example: Returns input data in dataframe format\r\n data.Data\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.2.4 (2022-04-05)\r\n------------------\r\n\r\n* Add Multi-family and commercial Waste collection\r\n* Add Animal feed production (AnF)\r\n\r\n\r\n0.2.3 (2021-11-24)\r\n------------------\r\n\r\n* Update Landfill\r\n\r\n\r\n0.2.1 (2021-10-02)\r\n------------------\r\n\r\n* New models: Gasification & Syngas combustion (GC), Refuse-Derived Fuel (RDF), Home composting (HC)\r\n\r\n\r\n0.1.9 (2021-05-10)\r\n------------------\r\n\r\n* Life cycle cost, input data for TS, References\r\n\r\n\r\n0.1.0 (2020-05-06)\r\n------------------\r\n\r\n* First release on PyPI. Data for the 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": "Input data for swolfpy's life-cycle process models (swolfpy_inputdata).",
"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-inputdata"
},
"split_keywords": [
"lca",
"solid_waste",
"waste_management",
"swolfpy",
"brightway2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "37f0955ca2ce22ad23b82379bf7c76e71974b68d986bb744741f0b6a0e252ce4",
"md5": "640a3835c5d3c2f070a4d06c7898c0f9",
"sha256": "3404ce740706af020e93a23c31863b3d35dff6003652ac684923a1b2a52b2880"
},
"downloads": -1,
"filename": "swolfpy_inputdata-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "640a3835c5d3c2f070a4d06c7898c0f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 429247,
"upload_time": "2023-07-30T16:14:11",
"upload_time_iso_8601": "2023-07-30T16:14:11.281703Z",
"url": "https://files.pythonhosted.org/packages/37/f0/955ca2ce22ad23b82379bf7c76e71974b68d986bb744741f0b6a0e252ce4/swolfpy_inputdata-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "233e36e290925043b4c9587afc132255a536b1a5bfb5283bf76615bba60aa825",
"md5": "aa2ce62e866a93a1ae14b5278b5c770c",
"sha256": "48b3685bffa86997b7036d6ce0ab7821fa315a1ec115d5caef78fab9c7a80490"
},
"downloads": -1,
"filename": "swolfpy_inputdata-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "aa2ce62e866a93a1ae14b5278b5c770c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 406418,
"upload_time": "2023-07-30T16:14:12",
"upload_time_iso_8601": "2023-07-30T16:14:12.877414Z",
"url": "https://files.pythonhosted.org/packages/23/3e/36e290925043b4c9587afc132255a536b1a5bfb5283bf76615bba60aa825/swolfpy_inputdata-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-30 16:14:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SwolfPy-Project",
"github_project": "swolfpy-inputdata",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "coverage",
"specs": []
},
{
"name": "jupyter",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "pre-commit",
"specs": []
},
{
"name": "pylint",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "pytest-flake8",
"specs": []
},
{
"name": "stats-arrays",
"specs": []
},
{
"name": "xlrd",
"specs": [
[
"==",
"1.2.0"
]
]
}
],
"lcname": "swolfpy-inputdata"
}
JSON
