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

Science Score: 33.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary

Keywords

circular-economy economics-models eeioa environmental-modelling environmental-science scenario-creator sustainability
Last synced: 9 months ago · JSON representation

Repository

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

Basic Info
Statistics
  • Stars: 22
  • Watchers: 3
  • Forks: 0
  • Open Issues: 5
  • Releases: 0
Topics
circular-economy economics-models eeioa environmental-modelling environmental-science scenario-creator sustainability
Created over 7 years ago · Last pushed over 3 years ago
Metadata Files
Readme Changelog Contributing License

README.md

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 License: GPL v3 Contributions welcome

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://fdonati@bitbucket.org/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, --transfmethod TEXT | 0 = PXP ITATC; 1 = PXP ITAMSC | | -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, --outputdataset | 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

Owner

  • Name: CML-IE-EB
  • Login: CMLPlatform
  • Kind: organization

GitHub Events

Total
  • Watch event: 3
Last Year
  • Watch event: 3

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 76
  • Total Committers: 1
  • Avg Commits per committer: 76.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
fdonati f****i@c****l 76
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 2
  • Total pull requests: 5
  • Average time to close issues: about 1 year
  • Average time to close pull requests: less than a minute
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 4
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • FDonati (1)
  • raffaem (1)
Pull Request Authors
  • dependabot[bot] (4)
  • FDonati (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (4)

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 6
proxy.golang.org: github.com/CMLPlatform/pycirk
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 9 months ago
proxy.golang.org: github.com/cmlplatform/pycirk
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 9 months ago

Dependencies

requirements.txt pypi
  • CacheControl ==0.12.6
  • appdirs ==1.4.3
  • certifi ==2019.11.28
  • chardet ==3.0.4
  • colorama ==0.4.3
  • contextlib2 ==0.6.0
  • distlib ==0.3.0
  • distro ==1.4.0
  • et-xmlfile ==1.0.1
  • html5lib ==1.0.1
  • idna ==2.8
  • ipaddr ==2.2.0
  • lockfile ==0.12.2
  • msgpack ==0.6.2
  • munch ==2.5.0
  • numpy ==1.20.2
  • openpyxl ==3.0.7
  • packaging ==20.3
  • pandas ==1.2.4
  • pep517 ==0.8.2
  • progress ==1.5
  • pyparsing ==2.4.6
  • python-dateutil ==2.8.1
  • pytoml ==0.1.21
  • pytz ==2021.1
  • requests ==2.22.0
  • retrying ==1.3.3
  • six ==1.14.0
  • urllib3 ==1.25.8
  • webencodings ==0.5.1
requirements_dev.txt pypi
  • Babel ==2.9.0 development
  • CacheControl ==0.12.6 development
  • Jinja2 ==2.11.3 development
  • MarkupSafe ==1.1.1 development
  • Pygments ==2.8.1 development
  • Sphinx ==3.5.4 development
  • alabaster ==0.7.12 development
  • appdirs ==1.4.3 development
  • certifi ==2019.11.28 development
  • chardet ==3.0.4 development
  • colorama ==0.4.3 development
  • contextlib2 ==0.6.0 development
  • distlib ==0.3.0 development
  • distro ==1.4.0 development
  • docutils ==0.16 development
  • et-xmlfile ==1.0.1 development
  • html5lib ==1.0.1 development
  • idna ==2.8 development
  • imagesize ==1.2.0 development
  • ipaddr ==2.2.0 development
  • lockfile ==0.12.2 development
  • msgpack ==0.6.2 development
  • munch ==2.5.0 development
  • numpy ==1.20.2 development
  • openpyxl ==3.0.7 development
  • packaging ==20.3 development
  • pandas ==1.2.4 development
  • pep517 ==0.8.2 development
  • progress ==1.5 development
  • pyparsing ==2.4.6 development
  • python-dateutil ==2.8.1 development
  • pytoml ==0.1.21 development
  • pytz ==2021.1 development
  • requests ==2.22.0 development
  • retrying ==1.3.3 development
  • six ==1.14.0 development
  • snowballstemmer ==2.1.0 development
  • sphinxcontrib-applehelp ==1.0.2 development
  • sphinxcontrib-devhelp ==1.0.2 development
  • sphinxcontrib-htmlhelp ==1.0.3 development
  • sphinxcontrib-jsmath ==1.0.1 development
  • sphinxcontrib-qthelp ==1.0.3 development
  • sphinxcontrib-serializinghtml ==1.1.4 development
  • urllib3 ==1.25.8 development
  • webencodings ==0.5.1 development