{"id":13724399,"url":"https://github.com/CMLPlatform/pycirk","last_synced_at":"2025-05-07T18:31:46.497Z","repository":{"id":41393420,"uuid":"157891556","full_name":"CMLPlatform/pycirk","owner":"CMLPlatform","description":"A python package to model Circular Economy policy and technological interventions in Environmentally Extended Input-Output Analysis starting from mrSUTs (EXIOBASE V3.3)","archived":false,"fork":false,"pushed_at":"2022-12-08T04:31:13.000Z","size":6151,"stargazers_count":21,"open_issues_count":5,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-25T11:41:16.965Z","etag":null,"topics":["circular-economy","economics-models","eeioa","environmental-modelling","environmental-science","scenario-creator","sustainability"],"latest_commit_sha":null,"homepage":"https://pycirk.readthedocs.io/en/latest/readme.html","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CMLPlatform.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-16T16:12:52.000Z","updated_at":"2024-12-25T08:07:22.000Z","dependencies_parsed_at":"2023-01-25T08:30:41.291Z","dependency_job_id":null,"html_url":"https://github.com/CMLPlatform/pycirk","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CMLPlatform%2Fpycirk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CMLPlatform%2Fpycirk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CMLPlatform%2Fpycirk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CMLPlatform%2Fpycirk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CMLPlatform","download_url":"https://codeload.github.com/CMLPlatform/pycirk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251419186,"owners_count":21586522,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circular-economy","economics-models","eeioa","environmental-modelling","environmental-science","scenario-creator","sustainability"],"created_at":"2024-08-03T01:01:56.486Z","updated_at":"2025-05-07T18:31:46.417Z","avatar_url":"https://github.com/CMLPlatform.png","language":"Python","funding_links":[],"categories":["Industrial Ecology"],"sub_categories":["Input Output Model"],"readme":"# pycirk\n\n_A python package to model Circular Economy policy and technological interventions in Environmentally Extended Input-Output Analysis starting from SUTs (EXIOBASE V3.3)_\n\n[![DOI](https://zenodo.org/badge/157891556.svg)](https://zenodo.org/badge/latestdoi/157891556)\n[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](resources/docs/CONTRIBUTING.md)\n\nDocumentation: https://pycirk.readthedocs.io/en/latest/readme.html\n\nTo cite the use of the software in your research please use the following publication:\n\n\"Modeling the circular economy in environmentally extended input-output tables: Methods, software and case study\"\n\nhttps://doi.org/10.1016/j.resconrec.2019.104508\n\n\n## Installation\n\n### Stable release\n\nRun in your terminal:\n\n\t$ pip install pycirk\n\n### From source\n\nClone repository:\n\n\t$ git clone https://fdonati@bitbucket.org/CML-IE/pycirk.git\nor\n\n\t$ git clone https://github.com/CMLPlatform/pycirk.git\n\n\nOnce you have a copy of the source, you can install it with:\n\n    $ python setup.py install\n\n### Data\n\nYou can download the biregional or multiregional database by following this link\n\nhttp://doi.org/10.5281/zenodo.4695823\n\nYou need to place the data inside the package\ne.g. /home/UserName/.local/lib/python3.6/site-packages/pycirk/data\n\n## Usage\n\n### Import package\n\n\timport pycirk\n\n### Initialize\n\n    my_work = pycirk.Launch(method, directory, aggregation, make_secondary)\n\n### set your scenarios and analysis\n\n1. Open scenarios.xls in the directory that was specified\n2. From there you can specify interventions and parameters for the analysis\n3. save and continue to the following steps\n\n### Run scenarios\n\nRun one specific scenario\n\n    my_work.scenario_results(scen_no, output_dataset)\n    (0 = baseline)\n\nRun all scenarios\n\n    my_work.all_results()\n\n### save scenarios\n\nSave your results\n\n    my_work.save_results()\n\n\n### Use from command line\n\npycirk --help\n\nUsage: pycirk [OPTIONS]\n\nConsole script for pycirk. A software to model policy and technological\ninterventions in Environmentally Extended Input-Output Analysis (EXIOBASE\nV3.3, 2011)\n\nOptions:\n\n| Command                    | Variables                            |\n|----------------------------|--------------------------------------|\n|  -tm, --transf_method TEXT | 0 = PXP ITA_TC; 1 = PXP ITA_MSC      |\n|  -dr, --directory TEXT     | if left black it will be default     |\n|  -ag, --aggregation        | 1 = bi-regional (EU-ROW)             |\n|                            | 0 = None (49 regions)                |\n|  -sc, --scenario TEXT      | all, 1, 2,... accepted - 0=baseline  |\n|  -s, --save TEXT           | False=no, True=yes                   |\n|  -od, --output_dataset     | False=no, True=yes                   |\n|  --help                    | Show this message and exit.          |\n\n\nCommand example\n\n    pycirk -tm 0 -dr \"\" -sc \"1\" -s True -od False\n\n## Features\n\nExamples of policies that can be modelled through the software:\n\n- sharing\n- recycling\n- life extension\n- rebound effects\n- substituion\n- market and value added changes\n- efficiency\n\nThe tables in which it is possible to apply changes:\n\n- total requirement matrix (A)\n- intermediate transactions (Z)\n- final demand (Y)\n- primary inputs (W)\n\n- emission intermediate extentions (E)\n- material intermediate extensions (M)\n- resource intermediate extensions (R)\n- emission final demand extension (EY)\n- material final demand extension (MY)\n- resource final demand extensions (RY)\n\n- primary inputs coefficients (w)\n- emission intermediate extentions coefficients (e)\n- material intermediate extensions coefficients (m)\n- resource intermediate extensions coefficients (r)\n- emission final demand extension coefficients (eY)\n- material final demand extension coefficients (mY)\n- resource final demand extensions coefficients (rY)\n\nIt is possible to specify:\n\n- region of the intervention\n- whether the intervention affects domestic, import transactions or both\n\n\nThis package was created with Cookiecutter and the `audreyr/cookiecutter-pypackage` project template.\n\nCookiecutter: https://github.com/audreyr/cookiecutter\naudreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCMLPlatform%2Fpycirk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCMLPlatform%2Fpycirk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCMLPlatform%2Fpycirk/lists"}