{"id":13723778,"url":"https://github.com/JRCSTU/CO2MPAS-TA","last_synced_at":"2025-05-07T17:31:20.198Z","repository":{"uuid":"68293915","full_name":"JRCSTU/CO2MPAS-TA","owner":"JRCSTU","description":"EU's  Type-Approving vehicle simulator predicting NEDC CO2 emissions from WLTP","archived":false,"fork":false,"pushed_at":"2023-11-15T12:32:56.000Z","size":293095,"stargazers_count":23,"open_issues_count":32,"forks_count":13,"subscribers_count":35,"default_branch":"master","last_synced_at":"2024-04-16T04:05:40.918Z","etag":null,"topics":["automotive","co2","eu","fuel-consumption","jrc","nedc","simulator","vehicle","wltp"],"latest_commit_sha":null,"homepage":"https://co2mpas.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"eupl-1.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JRCSTU.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.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,"governance":null}},"created_at":"2016-09-15T12:56:52.000Z","updated_at":"2023-10-27T12:02:44.000Z","dependencies_parsed_at":"2023-09-21T19:31:44.671Z","dependency_job_id":"7a285295-708d-4140-bed3-b438ad609382","html_url":"https://github.com/JRCSTU/CO2MPAS-TA","commit_stats":{"total_commits":4970,"total_committers":18,"mean_commits":276.1111111111111,"dds":0.4971830985915493,"last_synced_commit":"b946f2555411c3eb3efc9bad94cef55e733d4194"},"previous_names":[],"tags_count":327,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JRCSTU%2FCO2MPAS-TA","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JRCSTU%2FCO2MPAS-TA/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JRCSTU%2FCO2MPAS-TA/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JRCSTU%2FCO2MPAS-TA/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JRCSTU","download_url":"https://codeload.github.com/JRCSTU/CO2MPAS-TA/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":199402619,"owners_count":13594049,"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":["automotive","co2","eu","fuel-consumption","jrc","nedc","simulator","vehicle","wltp"],"created_at":"2024-08-03T01:01:45.573Z","updated_at":"2024-08-03T01:11:39.355Z","avatar_url":"https://github.com/JRCSTU.png","language":"Python","funding_links":[],"categories":["Consumption"],"sub_categories":["Mobility and Transportation"],"readme":".. image:: doc/_static/image/banner.png\n   :width: 100%\n\n.. _start-info:\n\n######################################################################\n|co2mpas|: Vehicle simulator predicting NEDC |CO2| emissions from WLTP\n######################################################################\n:release:          4.3.5\n:rel_date:         2023-11-13 15:00:00\n:home:             http://co2mpas.readthedocs.io/\n:repository:       https://github.com/JRCSTU/CO2MPAS-TA\n:pypi-repo:        https://pypi.org/project/co2mpas/\n:keywords:         |CO2|, fuel-consumption, WLTP, NEDC, vehicle, automotive,\n                   EU, JRC, IET, STU, correlation, back-translation, policy,\n                   monitoring, M1, N1, simulator, engineering, scientific\n:mail box:         \u003cJRC-CO2DICE@ec.europa.eu\u003e\n:team:             .. include:: AUTHORS.rst\n:copyright:        2015-2023 European Commission (`JRC \u003chttps://ec.europa.eu/jrc/\u003e`_)\n:license:          `EUPL 1.1+ \u003chttps://joinup.ec.europa.eu/software/page/eupl\u003e`_\n\n.. _end-info:\n.. _start-intro:\n\nWhat is |co2mpas|?\n==================\n|co2mpas| is backward-looking longitudinal-dynamics |CO2| and fuel-consumption\nsimulator for light-duty M1 \u0026 N1 vehicles (cars and vans), specially crafted to\n*estimate the CO2 emissions of vehicles undergoing NEDC* testing based on the\nemissions produced *WLTP testing* during :term:`type-approval`, according to\nthe :term:`EU legislation`\\s *1152/EUR/2017 and 1153/EUR/2017* (see `History`_\nsection, below).\n\nIt is an open-source project\n(`EUPL 1.1+ \u003chttps://joinup.ec.europa.eu/software/page/eupl\u003e`_) developed for\nPython-3.6+. It runs either as a *console command* or as a\n*desktop GUI application*, and it uses Excel-files or pure python structures\n(dictionary and lists) for its input \u0026 output data.\n\nHistory\n-------\nThe *European Commission* has introduced the *WLTP* as the test procedure for\nthe type I test of the European type-approval of Light-duty vehicles as of\nSeptember 2017. Its introduction has required the adaptation of |CO2|\ncertification and monitoring procedures set by European regulations (443/2009,\n510/2011, 1152/EUR/2017 and 1153/EUR/2017). European Commission’s *Joint\nResearch Centre* (JRC) has been assigned the development of this vehicle\nsimulator to facilitate this adaptation.\n\nThe European Regulation setting the conditions for using |co2mpas| can be\nfound in `the Comitology Register\n\u003chttp://ec.europa.eu/transparency/regcomitology/index.cfm?do=search.documentdetail\u0026dos_id=0\u0026ds_id=45835\u0026version=2\u003e`_\nafter its adoption by the *Climate Change Committee* which took place on\nJune 23, 2016, and its 2nd vote for modifications, in April 27, 2017.\n\n.. _end-intro:\n.. _start-install:\n\nInstallation\n============\n.. _start-install-dev:\n\nTo install |co2mpas| use (with root privileges):\n\n.. code-block:: console\n\n    $ pip install co2mpas\n\nOr download the latest git version and use (with root privileges):\n\n.. code-block:: console\n\n    $ python setup.py install\n\n\nInstall extras\n^^^^^^^^^^^^^^\nSome additional functionality is enabled installing the following extras:\n\n- ``cli``: enables the command line interface.\n- ``sync``: enables the time series synchronization tool (i.e.,\n  `syncing \u003chttps://github.com/vinci1it2000/syncing\u003e`_ previously named\n  ``datasync``).\n- ``gui``: enables the graphical user interface.\n- ``plot``: enables to plot the |co2mpas| model and the workflow of each run.\n- ``io``: enables to read/write excel files.\n- ``driver``: enables the driver model (currently is not available).\n\nTo install co2mpas and all extras, do:\n\n.. code-block:: console\n\n    $ pip install 'co2mpas[all]'\n\n.. _end-install-dev:\n.. _end-install:\n.. _start-quick:\n\nQuick Start\n===========\nThe following steps are basic commands to get familiar with |co2mpas| procedural\nworkflow using the command line interface:\n\n- `Run`_\n- `Input file`_\n- `Data synchronization`_\n\nRun\n---\nTo run |co2mpas| with some sample data, you have to:\n\n1. Generate some demo files inside the ``./input`` folder, to get familiar with\n   the input data (for more info check\n   the `link \u003c_build/co2mpas/co2mpas.cli.html#co2mpas-demo\u003e`__)::\n\n    ## Generate the demo files and open a demo file.\n    $ co2mpas demo ./input\n    $ start ./input/co2mpas_conventional.xlsx\n\n2. Run |co2mpas| and inspect the results in the ``./output`` folder.\n   The workflow is plotted on the browser (for more info check the\n   `link \u003c_build/co2mpas/co2mpas.cli.html#co2mpas-run\u003e`__)::\n\n    ## Run co2mpas and open the output folder.\n    $ co2mpas run ./input/co2mpas_conventional.xlsx -O ./output -PL\n    $ start ./output\n\n.. image:: _static/image/output_workflow.png\n   :width: 100%\n   :alt: Output workflow\n   :align: center\n\nInput file\n----------\nTo create an input file with your data, you have to:\n\n1. Generate an empty input template file (i.e., ``vehicle.xlsx``) inside\n   the ``./input`` folder::\n\n    ## Generate template file.\n    $ co2mpas template ./input/vehicle.xlsx -TT input\n\n2. Follow the instructions provided in the excel file to fill the required\n   inputs::\n\n    ## Open the input template.\n    $ start ./input/vehicle.xlsx\n\n.. image:: _static/image/input_template.png\n   :width: 100%\n   :alt: Input template\n   :align: center\n\nData synchronization\n--------------------\nTo synchronize the `dyno` and `OBD` data with the theoretical cycle, you have\nto:\n\n1. Generate a `synchronization template` file ``wltp.xlsx``::\n\n    ## Generate template file.\n    $ co2mpas syncing template ./to_sync/wltp.xlsx -CT wltp -WC class3b -GB automatic\n\n   .. note::\n      With the command above, the file contains the theoretical ``WLTP``\n      velocity profile for an ``automatic`` vehicle of ``class3b``. For more\n      info type ``co2mpas syncing template -h`` or click the\n      `link \u003c_build/co2mpas/co2mpas.cli.html#co2mpas-syncing-template\u003e`__\n2. Fill the ``dyno`` and ``obd`` sheets with the relative data collected in the\n   laboratory::\n\n    ## Open the input template.\n    $ start ./to_sync/wltp.xlsx\n\n3. Synchronize the data with the theoretical velocity profile::\n\n    $ co2mpas syncing sync ./to_sync/wltp.xlsx ./sync/wltp.sync.xlsx\n\n4. Copy/Paste the synchronized data (``wltp.sync.xlsx``) contained in the\n   ``synced`` sheet into the relative sheet of the input template::\n\n    ## Open the synchronized data.\n    $ start ./sync/wltp.sync.xlsx\n\n.. _end-quick:\n.. _start-sub:\n.. |co2mpas| replace:: CO\\ :sub:`2`\\ MPAS\n.. |CO2| replace:: CO\\ :sub:`2`\n.. _end-sub:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJRCSTU%2FCO2MPAS-TA","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJRCSTU%2FCO2MPAS-TA","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJRCSTU%2FCO2MPAS-TA/lists"}