Metadata-Version: 2.1
Name: bw2qsd
Version: 0.1.4
Summary: Bridging Brightway2 and QSD packages for LCA
Home-page: https://github.com/QSD-Group/BW2QSD
Author: Yalin Li
Author-email: mailto.yalin.li@gmail.com
License: UIUC
Keywords: quantitative sustainable design,Brightway2,life cycle assessment,database importer
Platform: Windows
Platform: Mac
Platform: Linux
Classifier: License :: OSI Approved :: University of Illinois/NCSA Open Source License
Classifier: Environment :: Console
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
License-File: LICENSE.txt

====================================================
BW2QSD: Bridging Brightway2 and QSD packages for LCA
====================================================

.. image:: https://img.shields.io/pypi/l/exposan?color=blue&logo=UIUC&style=flat
   :target: https://github.com/QSD-Group/BW2QSD/blob/master/LICENSE.txt
.. image:: https://img.shields.io/pypi/pyversions/bw2qsd?style=flat
   :target: https://pypi.python.org/pypi/bw2qsd
.. image:: https://img.shields.io/pypi/v/bw2qsd?style=flat&color=blue
   :target: https://pypi.org/project/bw2qsd/

.. Add a workflow/badge for testing

.. Set up binder?


What is ``BW2QSD``?
-------------------
``BW2QSD`` is an interface package to tailor the functions in `Brightway2 <https://brightway.dev/>`_ to existing and future quantitative sustainable design (QSD) packages.


Installation
------------
**Note**

For detailed instructions, please refer to the `tutorials <https://github.com/QSD-Group/BW2QSD/blob/main/bw2qsd/tutorials/>`_. It is recommended to create a separate conda environment.


The package can be downloaded from `PyPI <https://pypi.org/project/bw2qsd/>`_.

If you use pip:

.. code:: bash

    pip install bw2qsd


To get the git version (you can optionally use the depth flag to choose how many commit histories you want to clone):

.. code:: bash

    git clone https://github.com/QSD-Group/BW2QSD.git --depth=1


Author and Contributing
-----------------------
Authors: `Yalin Li <https://qsdsan.readthedocs.io/en/latest/authors/Yalin_Li.html>`_; `Joy Zhang <https://qsdsan.readthedocs.io/en/latest/authors/Joy_Zhang.html>`_

Please refer to the `Contributing to QSDsan <https://qsdsan.readthedocs.io/en/latest/CONTRIBUTING.html>`_ section of the documentation for instructions and guidelines.


License information
-------------------
Please refer to the ``LICENSE.txt`` for information on the terms & conditions for usage of this software, and a DISCLAIMER OF ALL WARRANTIES.
