{ "info": { "author": "Franco Donati", "author_email": "f.donati@cml.leidenuniv.nl", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Natural Language :: English", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only" ], "description": "######\npycirk\n######\n\n\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.. image:: https://zenodo.org/badge/157891556.svg\n :target: https://zenodo.org/badge/latestdoi/157891556\n.. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg\n :target: https://www.gnu.org/licenses/gpl-3.0\n.. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg\n :target: resources/docs/CONTRIBUTING.md)\n\n\n| Documentation: https://cmlplatform.github.io/pycirk/\n\n10.5281/zenodo.1492957\n\n===============\n1. Installation\n===============\n\n\n1.1. Stable release\n-------------------\n\nRun in your terminal:0\n\n\t$ pip install pycirk\n\n\n1.2. From source\n----------------\n\nClone repository:\n\n\t$ git clone https://fdonati@bitbucket.org/CML-IE/pycirk.git\n\nOnce you have a copy of the source, you can install it with:\n\n $ python setup.py install\n\n1.3 Data\n--------\n\nYou can download the biregional or multiregional database by following this link\n\nhttps://fdonaticml.stackstorage.com/s/OEPbzJQgdIcsAn1\n\nYou need to place the data inside the package\ne.g. /home/UserName/.local/lib/python3.6/site-packages/pycirk/data\n\n========\n2. Usage\n========\n\n2.1. Import package\n-------------------\n\n\timport pycirk\n\n\n2.2. Initialize\n---------------\n\n\tmy_work = pycirk.Launch(method, directory, aggregation)\n\n\n2.3. set your scenarios and analysis\n------------------------------------\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\n\n2.4. Run scenarios\n------------------\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\n2.5. save scenarios\n-------------------\n\nSave your results\n\n my_work.save_results()\n\n\n2.6. Use from command line\n\n2.6.1. pycirk --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+----------------------------+--------------------------------------+\n| Command | Variables |\n+============================+======================================+\n| -tm, --transf_method TEXT | 0 = PXP ITA_TC; 1 = PXP ITA_MSC |\n+----------------------------+--------------------------------------+\n| -dr, --directory TEXT | if left black it will be default |\n+----------------------------+--------------------------------------+\n| -ag, --aggregation | 1 = bi-regional (EU-ROW) |\n| | 0 = None (49 regions) |\n+----------------------------+--------------------------------------+\n| -sc, --scenario TEXT | all, 1, 2,... accepted - 0=baseline |\n+----------------------------+--------------------------------------+\n| -s, --save TEXT | False=no, True=yes |\n+----------------------------+--------------------------------------+\n| -od, --output_dataset | False=no, True=yes |\n+----------------------------+--------------------------------------+\n| --help | Show this message and exit. |\n+----------------------------+--------------------------------------+\n\n2.6.2. Command example\n\n pycirk -tm 0 -dr \"\" -sc \"1\" -s True -od False\n\n\n\n===========\n3. Features\n===========\n\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\n====================\n4. Important modules\n====================\n\n4.1. scenarios.xls\n------------------\n\nFrom this .xls file it is possible to set different types of interventions and the analysis to perform:\n\n- matrix = specifies in which matrix of IOT the changes are applied\n- change_type = Primary and ancillary are only used to specify the type of intervention from a conceptual level\n- reg_o or reg_d = Regional coordinates (o=origin or row, d=destination or column)\n- cat_o or cat_d = category (e.g. products or extensions ) coordinates (o=origin or row, d=destination or column)\n- kt = technical coefficient (max achievable technically); a negative value means reduction; unit = %\n- ka = absolute values for addition\n- kp = penetration coefficient (level of market penetration of the policy); unit = %\n- copy = allows you to copy a specific transation to a different point in the matrices (useful for proxy creation)\n- substitution = tells the software whether it needs to substitute values among specified categories\n- sk = which intervention should be substituted\n- swk = Substitution weighing factor (how much of the original transaction should be substituted); allows to simulate difference in prices and physical properties between categories; unit = %\n\nThese can be set for:\n\n- product category e.g. C_STEL (basic iron), C_PULP (pulp), etc.\n- final demand category e.g. F_HOUS (households), F_GOVE (government), etc.\n- primary input category e.g. E_HRHS (employment highly skilled), T_TLSA (taxes less subsidies), etc.\n- emissions extensions e.g. E_CO2_c (CO2 - combustion)\n- material extensions e.g. NI.02 (Nature Inputs: Coking Coal)\n- resource extension e.g. L_1.1 (Land use - Arable Land - Rice)\n\nFurthemore, from the analysis sheet you can set the following variables to be compared in the analysis:\n\n- product categories\n- primary input categories\n- emissions extensions\n- material extensions\n- resource extensions\n- region of interest\n- impact categories # Please see the data_validation_list sheet in the scenarios.xls file for the comprehensive list\n\n\n\n==========\n6. Credits\n==========\n\nThanks to dr. Arnold Tukker, dr. Joao Dias Rodriguez for the supervision\ndr. Arjan de Koning for knowledge support in exiobase\nMSc. Glenn Auguilar Hernandez for testing\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.1.0 (2018-05-11)\n------------------\n\n* First release on PyPI.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://bitbucket.org/CML-IE/pycirk/src/master/", "keywords": "pycirk", "license": "GNU General Public License v3", "maintainer": "", "maintainer_email": "", "name": "pycirk", "package_url": "https://pypi.org/project/pycirk/", "platform": "", "project_url": "https://pypi.org/project/pycirk/", "project_urls": { "Homepage": "https://bitbucket.org/CML-IE/pycirk/src/master/" }, "release_url": "https://pypi.org/project/pycirk/1.5.0/", "requires_dist": [ "Click (>=7.0)", "pandas (>=0.24.2)", "numpy (>=1.16.4)", "xlrd (>=1.1.0)", "munch (>=2.3.2)", "openpyxl (>=2.6.2)", "pytest (>=5.0.1)", "setuptools (>=40.8.0)" ], "requires_python": "", "summary": "A software to model Circular Economy policy andtechnological interventions in Environmentally Extended Input-Output Analysis (EXIOBASE V3.3)", "version": "1.5.0" }, "last_serial": 5832296, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "fe3892c721768835f9950dad690ffff4", "sha256": "fe1a3d0ed491155a9005e5e1c3c7cd26350bf95fb497cb735550eedebc02877b" }, "downloads": -1, "filename": "pycirk-1.0.0-py36-none-any.whl", "has_sig": false, "md5_digest": "fe3892c721768835f9950dad690ffff4", "packagetype": "bdist_wheel", "python_version": "py36", "requires_python": null, "size": 139575, "upload_time": "2018-11-21T04:52:37", "url": "https://files.pythonhosted.org/packages/6f/c0/565033e754d845b192f3ee42b46472b8ab3214a4a75792078592e2448bab/pycirk-1.0.0-py36-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bf5497e104386fb5ead93a1623593a0a", "sha256": "0e1e6389c7a70fa11c4b105d1146f831962f6468cb9e37bc2ac9b9349dd88cc2" }, "downloads": -1, "filename": "pycirk-1.0.0.tar.gz", "has_sig": false, "md5_digest": "bf5497e104386fb5ead93a1623593a0a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 208923, "upload_time": "2018-11-21T04:52:42", "url": "https://files.pythonhosted.org/packages/0b/c1/689dbe6f87519dff92346484cf67801ca0bda7f7ad2a2ed12564195f6aca/pycirk-1.0.0.tar.gz" } ], "1.5.0": [ { "comment_text": "", "digests": { "md5": "e64564aa1aac710d8c9cbd1d727fef76", "sha256": "77c23e55455ff74f7781f5b9be52efbebd0c2eceb99a493ad40bacc7a7cd7f90" }, "downloads": -1, "filename": "pycirk-1.5.0-py36-none-any.whl", "has_sig": false, "md5_digest": "e64564aa1aac710d8c9cbd1d727fef76", "packagetype": "bdist_wheel", "python_version": "py36", "requires_python": null, "size": 151562, "upload_time": "2019-09-15T15:12:35", "url": "https://files.pythonhosted.org/packages/e3/4b/f90af9155a4ff42ba8f13c0ea37a7ef16918132555ca923b82594bea39d2/pycirk-1.5.0-py36-none-any.whl" }, { "comment_text": "", "digests": { "md5": "46f7052697e10d62359579fdd67c275f", "sha256": "759bcdbde06e9f3e91203ea82a62d2d0a4b950c620fe42d2fe7051be06706e8b" }, "downloads": -1, "filename": "pycirk-1.5.0.tar.gz", "has_sig": false, "md5_digest": "46f7052697e10d62359579fdd67c275f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 253889, "upload_time": "2019-09-15T15:12:38", "url": "https://files.pythonhosted.org/packages/fe/64/b15c9ec8dd52fcca24b83d6d395164b868b45a2f7176ed03f54cfe81b80b/pycirk-1.5.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e64564aa1aac710d8c9cbd1d727fef76", "sha256": "77c23e55455ff74f7781f5b9be52efbebd0c2eceb99a493ad40bacc7a7cd7f90" }, "downloads": -1, "filename": "pycirk-1.5.0-py36-none-any.whl", "has_sig": false, "md5_digest": "e64564aa1aac710d8c9cbd1d727fef76", "packagetype": "bdist_wheel", "python_version": "py36", "requires_python": null, "size": 151562, "upload_time": "2019-09-15T15:12:35", "url": "https://files.pythonhosted.org/packages/e3/4b/f90af9155a4ff42ba8f13c0ea37a7ef16918132555ca923b82594bea39d2/pycirk-1.5.0-py36-none-any.whl" }, { "comment_text": "", "digests": { "md5": "46f7052697e10d62359579fdd67c275f", "sha256": "759bcdbde06e9f3e91203ea82a62d2d0a4b950c620fe42d2fe7051be06706e8b" }, "downloads": -1, "filename": "pycirk-1.5.0.tar.gz", "has_sig": false, "md5_digest": "46f7052697e10d62359579fdd67c275f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 253889, "upload_time": "2019-09-15T15:12:38", "url": "https://files.pythonhosted.org/packages/fe/64/b15c9ec8dd52fcca24b83d6d395164b868b45a2f7176ed03f54cfe81b80b/pycirk-1.5.0.tar.gz" } ] }