Quickstart Guide

Graphical User Interface

If you start EC-PeT by (double) clicking the appropriate symbol or whatever, depending on your installation, the initial screen will come up:

Graphical user interface

Graphical user interface

As a first step create a new project:

  1. Click File >> New Project

  2. Select a folder, where you want to store the project file and a name for the project file. Then click Save

    Note

    The project file will get rather large during processing, as a rule of thumb, it will reach a similar size as the raw data.

  3. Create a config by clicking Config >> Create.

  4. The Create Wizard comes up and guides you adjusting the most important settings. Click Next on each page and Finish on the last.

  5. Write the config to your project file by selecting Config >> Store (this will actually create the project file).

  6. Click the START button, sit back and watch the progress bars finish.

Command-line Interface

Assuming ecpet is in your path, you can start EC-PeT by the command ecpet.

Invoking ecpet without any argument brings up the graphical user interface. Just type ecpet -h to get a simple help:

usage: ecpet [-h] [-v | -q] {gui,run,update,make} ...

EC-PeT -- elaboratio concursuum perturbationum Treverensis *)

positional arguments:
  {gui,run,update,make}
    gui                 start graphic user interface (GUI)
    run                 use existing configuration, create new project and run
                        it
    update              use existing configuration, alter it according to the
                        command-line options, create new project and run it
    make                generate a new default configuration file (including
                        the command-line options)

optional arguments:
  -h, --help            show this help message and exit
  -v                    increase output verbosity
  -q                    decrease output verbosity

*)= eddy-covariance software from Trier

To get similar help for the subcommands gui, run, update, and make type for example ecpet run -h.

Basic Command Examples

  1. Start the GUI:

    ecpet gui

  2. Create a default configuration:

    ecpet make -o my_config.conf

  3. Run processing with existing configuration:

    ecpet run -c my_config.conf -p my_project.ecp

  4. Update configuration and run:

    ecpet update -c my_config.conf -p my_project.ecp --start-date 2023-01-01 --end-date 2023-01-31

Verbosity

The program usually provides the user with information about the processing progress. To reduce the amount of output, use the -q option. Use -v to get more detailed information. Use --debug to enable debugging output. The --debug-insane option provides full debugging output, even from code that is executed many times (be warned: this option produces insane amounts of output — that’s why it’s named this way).

Quick Processing Example

Here’s a complete example for processing a dataset:

  1. Prepare your data: Choose your a working directory, e.g. /home/user/data/ and ensure your TOA5 files are in the subdirectory in/, e.g., /home/user/data/in/

  2. Create configuration:: Change to your a working directory, e.g. cd /home/user/data/ and run:

    ecpet make -o processing.conf \
    --start-date 2023-06-01 \
    --end-date 2023-06-30

  3. Edit configuration: Open processing.conf in a text editor and adjust settings as needed

  4. Run processing:

    ecpet run -c processing.conf -p my_project.ecp -v

  5. Check results: Output files will be in /home/user/data/processed/

Common Issues

File permissions: Ensure you have read access to input files and write access to output directories.

Memory usage: Large datasets may require significant RAM. Monitor system resources during processing.

Configuration errors: Use ecpet make to generate a valid template configuration file.

Path issues: Use absolute paths in configuration files to avoid ambiguity. Use relative paths in configuration files for portability.

Next Steps