Metadata-Version: 2.1
Name: swolfpy
Version: 0.1.8
Summary: Solid Waste Optimization Life-cycle Framework in Python(SwolfPy)
Home-page: https://bitbucket.org/swolfpy/swolfpy
Author: Mojtaba Sardarmehni
Author-email: msardar2@ncsu.edu
License: GNU GENERAL PUBLIC LICENSE V2
Keywords: swolfpy
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Natural Language :: English
Requires-Python: >=3.5
Requires-Dist: swolfpy-inputdata
Requires-Dist: swolfpy-processmodels
Requires-Dist: brightway2
Requires-Dist: PySide2
Requires-Dist: plotly
Requires-Dist: graphviz

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


* Free software: GNU GENERAL PUBLIC LICENSE V2
* Documentation: https://swolfpy.readthedocs.io.
* Repository: https://bitbucket.org/swolfpy/swolfpy
* Other links: 
        https://go.ncsu.edu/swolfpy

        https://jwlevis.wixsite.com/swolf


Features
--------

* Life cycle assessment of Municipal Solid Waste (MSW) systems. Process models include Landfill, Waste-to-Energy (WTE), Composting, Anaerobic Digestion (AD), Single Stream Material Recovery Facility (MRF), Reprocessing, and Collection.
* Monte Carlo simulation
* Optimization


.. 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- Add conda channels::

        conda config --append channels conda-forge
        conda config --append channels cmutel
        conda config --append channels haasad

4- Create a new environment for swolfpy::

        conda create --name swolfpy python=3.7

5- Activate the environment::

        conda activate swolfpy

6- Install swolfpy in the environment::

        pip install swolfpy

7- Open python to run swolfpy::

        ipython

8- Run swolfpy in python::

        from swolfpy import *
        swolfpy()

.. endInstallation


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

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 Reporcessing. Revise Functional units. Reivse 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 nd Collection.


