Organisation of the Documentation#

The XDIGI2CSV program is the primary program that this repository was created for. It allows for the conversion of (X)DIGI files to CSV files.

If you only want to access pre-generated CSV-like files, generated by the XDIGI2CSV program, there’s no need to clone the project. Instead, you can directly:

However, if you want to generate your own CSV files using the XDIGI2CSV programs, or to run other programs, you will need to clone this repository and set it up. To learn how to do this, please refer to:

  • the Programs page for more information about the programs that can executed through this repository

  • the Setup Guide for specific instructions in how to set up this repository.

  • The Configuration Files and Helper Scripts for more information on how configuration is managed in this repository.

  • The XDIGI2CSV Program page to learn how to run the XDGI2CSV program, which is the main program.

  • The Other Programs page to learn how to execute other programs, with examples.

Organisation of the Git Repository#

In the git repository:

  • run contains helper scripts to run Moore or Allen programs, in particular xdigi2csv that allows to convert a (X)DIGI file into a set of CSV files

  • jobs: contains YAML configuration files that configure the scripts to run

  • checks contains a set of python scripts and notebooks that analyses the outputs of the Allen and Moore program.

  • readme contains README markdown files used in the documentation.

  • docs contains files to generate the sphinx documentation