QA Tool

quality assurance tool by EMPA for ACTRIS

https://voc-qc.nilu.no/

API

avoca.bindings.qa_tool.export_EmpaQATool(df: DataFrame, export_path: Path | None = None, station: str = 'XXX', revision_date: datetime | None = None, dataset: datetime | str | None = None, export_names: dict[str, str] | None = None, datetime_offsets: tuple[timedelta, timedelta] | None = None, substances: list[str] | None = None, rounding_decimals: int = 4, df_substances: DataFrame | None = None, out_filepath: Path | None = None) → Path

Export to the EmpaQATool format.

The exported file from the program can then be imported to the tool on https://voc-qc.nilu.no/Import The specs fro that file can be found in https://voc-qc.nilu.no/doc/CSVImport_FormatSpecifications.pdf

This will add the additional data from the dataframe.

The file genereated will be named: export_path/[station]_[dataset]_[revision].csv

Parameters:

  • df – Calculation dataframe

  • export_path – Path (directory) to export the file

  • station – Station name to use in the file name

  • revision_date – Revision date as datetime to use in the file name

  • dataset – Dataset name as datetime or string to use in the file name

  • export_names – Dictionary of substance names to use in the file name The keys are the substance names and the values are the names to use in the file.

  • datetime_offsets – Tuple of two timedelta to use for the start and end datetime

  • substances – List of substances to export. You can also specify group names. If not specified, this will use the substances from df_substances. If a substance is present here and not in df_substances, it will still be exported.

  • rounding_decimals – Number of decimals to round the values to.

  • df_substances – DataFrame with substance information. If provided, the substances to export will be taken from this dataframe. Columns: - index: substance name - export: bool, whether to export the substance - export_name: str, name to use in the export file

  • out_filepath – Path to the output file. if provided, pandas will directly write to this, instead of generating the output file.

Returns:

Path to the exported file.