Metadata-Version: 2.1
Name: swolfpy
Version: 0.1.3
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: 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
Requires-Python: >=3.5
Requires-Dist: brightway2
Requires-Dist: jupyter
Requires-Dist: PySide2
Requires-Dist: pandas

.. 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://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.
* 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), 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 PySWOLF::

        conda create --name swolfpy python=3.7

5- Activate the environment::

        conda activate swolfpy

6- Install PySWOLF in the environment::

        pip install swolfpy

7- Open python to run swolfpy::

        ipython

8- Run swolfpy in python::

        from swolfpy import *
        swolfpy()

.. endInstallation

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


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

0.1.0 (2020-02-27)
------------------

* First release on PyPI.


