1. Install

On Windows you may install the latest all-In-One archive and ensure it contains (or upgrade to) the latest CO2MPAS python package; alternatively, you may install the developer version.

Tip

Installing and using ALLINONE is the official procedure for running CO2MPAS for Type Approval (TA).

1.1. All-In-One Installation under Windows

  • Download all-in-one archive from https://github.com/JRCSTU/CO2MPAS-TA/releases/ (it only runs on 64bit PCs).

    Tip

    Search in older releases if the latest does not contain an ALLINONE archive, and remember to upgrade CO2MPAS afterwords.

  • Use the original “7z” extractor, since “plain-zip” application produces out-of-memory errors when expanding long directories.

    Note

    Prefer to extract it in a folder without any spaces in its path.

    Extract Co2mpas-ALLINONE into Desktop
  • Run INSTALL.bat script contained in the root of the unzipped folder. It will install links for commons CO2MPAS tasks under your Windows Start-Menu.

    Install Co2mpas-ALLINONE shortcupts into Window Start-menu.
  • You can start CO2MPAS from Windows start-menu by pressing the [WinKey] and start typing ‘co2mpas’, or by selecting the CO2MPAS menu item from All Programs.

    Launch |co2mpas| from Window Start-menu.

    Alternatively, advanced users may continue to use the Console.

Note

If you have downloaded an all-in-one from previous version of CO2MPAS you may upgrade CO2MPAS contained within. Follow the instructions in the “Upgrade” section, below.

1.2. Upgrade CO2MPAS

Uninstall and re-install it from the CO2MPAS CONSOLE:

pip uninstall co2mpas
pip install co2mpas

Tip

Don’t forget verify that the installed version is the correct one by checking the output of this command:

co2mpas -vV

1.2.1. Upgrade CO2MPAS in a corporate environment

Note

This option has been retracted - please either download ALLINONE or just the wheel from https://pypi.org/project/co2mpas/ and install it, asuming that no other dependencies have changed.

1.3. File Contents

RUN_CO2MPAS.bat            ## Asks for Input & Output folders, and runs CO2MPAS for all Excel-files in Input.
CONSOLE.bat                ## Open a python+cygwin enabled `cmd.exe` console.

co2mpas-env.bat            ## Sets env-vars for python+cygwin and launches arguments as new command
                           ## !!!!! DO NOT MODIFY !!!!! used by Windows StartMenu shortcuts.
bash-console.bat           ## Open a python+cygwin enabled `bash` console.


CO2MPAS/                   ## User's HOME directory containing release-files and tutorial-folders.
CO2MPAS/.*                 ## Configuration-files auto-generated by various programs, starting with dot(.).

Apps/Cygwin/               ## Unix-folders for *Cygwin* environment (i.e. bash).
Apps/WinPython/            ## Python environment (co2mpas is pre-installed inside it).
Apps/Console2/             ## A versatile console-window supporting decent copy-paste.
Apps/graphviz/             ## Graph-plotting library (needed to generate model-plots).
Apps/gpg4win-2.3.3.exe     ## GPG cryptographic suite installer for Windows.
vc_redist.x64.exe          ## Microsoft Visual C++ Redistributable for Visual Studio 2015
                           #  (KB2977003 Windows update, prerequisite for running Python-3.5.x).
CO2MPAS_logo.ico           ## The logos used by the INSTALL.bat script.

README                     ## This file, with instructions on this pre-populated folder.

1.4. Generic Tips

  • You may freely move & copy this folder around. But prefer NOT TO HAVE SPACES IN THE PATH LEADING TO IT.

  • To view & edit textual files, such as .txt, .bat or config-files starting with dot(.), you may use the “ancient” Window notepad editor, but it will save you from a lot of trouble if you download and install notepad++ from: http://portableapps.com/apps/development/notepadpp_portable (no admin-rights needed).

    Even better if you combine it with the “gem” file-manager of the ‘90s, TotalCommander, from http://www.ghisler.com/ (no admin-rights needed). From inside this file-manager, F3 key-shortcut views files.

  • The Cygwin POSIX-environment and its accompanying bash-shell are a much better choice to give console-commands compare to cmd.exe prompt, supporting auto-completion for various commands (with [TAB] key) and enhanced history search (with [UP]/[DOWN] cursor-keys).

    There are MANY tutorials and crash-courses for bash:

  • The console automatically copies into clipboard anything that is selected with the mouse. In case of errors, copy and paste the offending commands and their error-messages to emails sent to JRC.

  • When a new CO2MPAS version comes out it is not necessary to download the full ALLINONE archive, but you choose instead to just upgrade co2mpas.

    Please follow the upgrade procedure in the main documentation.