Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/CMLPlatform/pycirk

A python package to model Circular Economy policy and technological interventions in Environmentally Extended Input-Output Analysis starting from mrSUTs (EXIOBASE V3.3)
https://github.com/CMLPlatform/pycirk

circular-economy economics-models eeioa environmental-modelling environmental-science scenario-creator sustainability

Last synced: 2 months ago
JSON representation

A python package to model Circular Economy policy and technological interventions in Environmentally Extended Input-Output Analysis starting from mrSUTs (EXIOBASE V3.3)

Host: GitHub
URL: https://github.com/CMLPlatform/pycirk
Owner: CMLPlatform
License: other
Created: 2018-11-16T16:12:52.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-12-08T04:31:13.000Z (over 1 year ago)
Last Synced: 2024-04-11T18:19:42.395Z (3 months ago)
Topics: circular-economy, economics-models, eeioa, environmental-modelling, environmental-science, scenario-creator, sustainability
Language: Python
Homepage: https://pycirk.readthedocs.io/en/latest/readme.html
Size: 5.87 MB
Stars: 19
Watchers: 4
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE

Lists

open-sustainable-technology - pycirk - Model Circular Economy policy and technological interventions in Environmentally Extended Input-Output Analysis. (Industrial Ecology / Circular Economy and Waste)

README

        # pycirk

_A python package to model Circular Economy policy and technological interventions in Environmentally Extended Input-Output Analysis starting from SUTs (EXIOBASE V3.3)_

[![DOI](https://zenodo.org/badge/157891556.svg)](https://zenodo.org/badge/latestdoi/157891556)

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](resources/docs/CONTRIBUTING.md)

Documentation: https://pycirk.readthedocs.io/en/latest/readme.html

To cite the use of the software in your research please use the following publication:

"Modeling the circular economy in environmentally extended input-output tables: Methods, software and case study"

https://doi.org/10.1016/j.resconrec.2019.104508

## Installation

### Stable release

Run in your terminal:

	$ pip install pycirk

### From source

Clone repository:

	$ git clone https://[email protected]/CML-IE/pycirk.git

or

	$ git clone https://github.com/CMLPlatform/pycirk.git

Once you have a copy of the source, you can install it with:

    $ python setup.py install

### Data

You can download the biregional or multiregional database by following this link

http://doi.org/10.5281/zenodo.4695823

You need to place the data inside the package

e.g. /home/UserName/.local/lib/python3.6/site-packages/pycirk/data

## Usage

### Import package

	import pycirk

### Initialize

    my_work = pycirk.Launch(method, directory, aggregation, make_secondary)

### set your scenarios and analysis

1. Open scenarios.xls in the directory that was specified

2. From there you can specify interventions and parameters for the analysis

3. save and continue to the following steps

### Run scenarios

Run one specific scenario

    my_work.scenario_results(scen_no, output_dataset)

    (0 = baseline)

Run all scenarios

    my_work.all_results()

### save scenarios

Save your results

    my_work.save_results()

### Use from command line

pycirk --help

Usage: pycirk [OPTIONS]

Console script for pycirk. A software to model policy and technological

interventions in Environmentally Extended Input-Output Analysis (EXIOBASE

V3.3, 2011)

Options:

| Command                    | Variables                            |

|----------------------------|--------------------------------------|

|  -tm, --transf_method TEXT | 0 = PXP ITA_TC; 1 = PXP ITA_MSC      |

|  -dr, --directory TEXT     | if left black it will be default     |

|  -ag, --aggregation        | 1 = bi-regional (EU-ROW)             |

|                            | 0 = None (49 regions)                |

|  -sc, --scenario TEXT      | all, 1, 2,... accepted - 0=baseline  |

|  -s, --save TEXT           | False=no, True=yes                   |

|  -od, --output_dataset     | False=no, True=yes                   |

|  --help                    | Show this message and exit.          |

Command example

    pycirk -tm 0 -dr "" -sc "1" -s True -od False

## Features

Examples of policies that can be modelled through the software:

- sharing

- recycling

- life extension

- rebound effects

- substituion

- market and value added changes

- efficiency

The tables in which it is possible to apply changes:

- total requirement matrix (A)

- intermediate transactions (Z)

- final demand (Y)

- primary inputs (W)

- emission intermediate extentions (E)

- material intermediate extensions (M)

- resource intermediate extensions (R)

- emission final demand extension (EY)

- material final demand extension (MY)

- resource final demand extensions (RY)

- primary inputs coefficients (w)

- emission intermediate extentions coefficients (e)

- material intermediate extensions coefficients (m)

- resource intermediate extensions coefficients (r)

- emission final demand extension coefficients (eY)

- material final demand extension coefficients (mY)

- resource final demand extensions coefficients (rY)

It is possible to specify:

- region of the intervention

- whether the intervention affects domestic, import transactions or both

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