airbase.cli module

class airbase.cli.Country(value)

Bases: str, Enum

An enumeration.

AD = 'AD'

AL = 'AL'

AT = 'AT'

BA = 'BA'

BE = 'BE'

BG = 'BG'

CH = 'CH'

CY = 'CY'

CZ = 'CZ'

DE = 'DE'

DK = 'DK'

EE = 'EE'

ES = 'ES'

FI = 'FI'

FR = 'FR'

GB = 'GB'

GR = 'GR'

HR = 'HR'

HU = 'HU'

IE = 'IE'

IS = 'IS'

IT = 'IT'

LT = 'LT'

LU = 'LU'

LV = 'LV'

ME = 'ME'

MK = 'MK'

MT = 'MT'

NL = 'NL'

NO = 'NO'

PL = 'PL'

PT = 'PT'

RO = 'RO'

RS = 'RS'

SE = 'SE'

SI = 'SI'

SK = 'SK'

TR = 'TR'

XK = 'XK'

class airbase.cli.Frequency(value)

Bases: str, Enum

An enumeration.

property aggregation_type: AggregationType

daily = 'daily'

hourly = 'hourly'

other = 'other'

class airbase.cli.Pollutant(value)

Bases: str, Enum

An enumeration.

Acenaphthene = 'Acenaphthene'

Acenaphthylene = 'Acenaphthylene'

Acenaphtylene = 'Acenaphtylene'

Acetaldehyde = 'Acetaldehyde'

Acetone = 'Acetone'

Acetophenone = 'Acetophenone'

Acroleine = 'Acroleine'

Al = 'Al'

Aldrin = 'Aldrin'

Anthanthrene = 'Anthanthrene'

Anthracene = 'Anthracene'

As = 'As'

Atrazine = 'Atrazine'

BDE100 = 'BDE100'

BDE153 = 'BDE153'

BDE154 = 'BDE154'

BDE209 = 'BDE209'

BDE47 = 'BDE47'

BDE85 = 'BDE85'

BDE99 = 'BDE99'

BS = 'BS'

BTBPT = 'BTBPT'

BaP = 'BaP'

Benzaldehyde = 'Benzaldehyde'

Biphenyl = 'Biphenyl'

Butanales = 'Butanales'

Butenes = 'Butenes'

C2Cl4 = 'C2Cl4'

C2H6 = 'C2H6'

C6H12 = 'C6H12'

C6H12O2 = 'C6H12O2'

C6H14 = 'C6H14'

C6H4Cl2 = 'C6H4Cl2'

C6H6 = 'C6H6'

C7H16 = 'C7H16'

C8H18 = 'C8H18'

C8H8O = 'C8H8O'

C9H12 = 'C9H12'

C9H20 = 'C9H20'

CDD1N = 'CDD1N'

CDD4X = 'CDD4X'

CDD6P = 'CDD6P'

CDD6X = 'CDD6X'

CDD9X = 'CDD9X'

CDDO = 'CDDO'

CDF2N = 'CDF2N'

CDF2T = 'CDF2T'

CDF4X = 'CDF4X'

CDF6P = 'CDF6P'

CDF6X = 'CDF6X'

CDF9P = 'CDF9P'

CDF9X = 'CDF9X'

CDFDN = 'CDFDN'

CDFDX = 'CDFDX'

CDFO = 'CDFO'

CDFP2 = 'CDFP2'

CDFX1 = 'CDFX1'

CH2Cl2 = 'CH2Cl2'

CH4 = 'CH4'

CO = 'CO'

CO2 = 'CO2'

CS2 = 'CS2'

Cd = 'Cd'

Cholanthrene = 'Cholanthrene'

Chrysene = 'Chrysene'

Co = 'Co'

Coronene = 'Coronene'

Cr = 'Cr'

Crotonaldehyde = 'Crotonaldehyde'

Cu = 'Cu'

DBDPE = 'DBDPE'

DCMU = 'DCMU'

Dibenzofuran = 'Dibenzofuran'

Dibenzothiophene = 'Dibenzothiophene'

Dieldrin = 'Dieldrin'

EC = 'EC'

Endrin = 'Endrin'

Fe = 'Fe'

Fluoranthene = 'Fluoranthene'

Fluorene = 'Fluorene'

Glyoxal = 'Glyoxal'

H2S = 'H2S'

HBB = 'HBB'

HBCD = 'HBCD'

HCB = 'HCB'

HCHO = 'HCHO'

HCl = 'HCl'

HF = 'HF'

HNO3 = 'HNO3'

Heptachlor = 'Heptachlor'

Hg = 'Hg'

Hg0 = 'Hg0'

Isoproturon = 'Isoproturon'

MCCP = 'MCCP'

Methacroleine = 'Methacroleine'

Methylglyoxal = 'Methylglyoxal'

Mn = 'Mn'

Mo = 'Mo'

N2O = 'N2O'

NH3 = 'NH3'

NH4 = 'NH4'

NO = 'NO'

NO2 = 'NO2'

NO3 = 'NO3'

NOy = 'NOy'

NT = 'NT'

NVPM1 = 'NVPM1'

NVPM10 = 'NVPM10'

Naphtalene = 'Naphtalene'

Naphthalene = 'Naphthalene'

Ni = 'Ni'

O3 = 'O3'

OC = 'OC'

PAH = 'PAH'

PAN = 'PAN'

PBEB = 'PBEB'

PBT = 'PBT'

PCB_122 = 'PCB_122'

PCB_123 = 'PCB_123'

PCB_128 = 'PCB_128'

PCB_138 = 'PCB_138'

PFBA = 'PFBA'

PFBS = 'PFBS'

PFDA = 'PFDA'

PFDS = 'PFDS'

PFHpA = 'PFHpA'

PFHxA = 'PFHxA'

PFHxS = 'PFHxS'

PFNA = 'PFNA'

PFOA = 'PFOA'

PFOS = 'PFOS'

PFOSA = 'PFOSA'

PFPeA = 'PFPeA'

PFUnDA = 'PFUnDA'

PM1 = 'PM1'

PM10 = 'PM10'

Pb = 'Pb'

Pentenes = 'Pentenes'

Perylene = 'Perylene'

Phenanthrene = 'Phenanthrene'

Propanal = 'Propanal'

Pyrene = 'Pyrene'

Radioactivity = 'Radioactivity'

Retene = 'Retene'

SA = 'SA'

SCCP = 'SCCP'

SO2 = 'SO2'

SPM = 'SPM'

Se = 'Se'

TBP = 'TBP'

TCDD = 'TCDD'

TI = 'TI'

TP = 'TP'

UFPs = 'UFPs'

V = 'V'

VC = 'VC'

VPM1 = 'VPM1'

VPM10 = 'VPM10'

Valeraldehyde = 'Valeraldehyde'

Vanadium = 'Vanadium'

Zn = 'Zn'

k = 'k'

pH = 'pH'

precip_amount = 'precip_amount'

precip_amount_off = 'precip_amount_off'

trans_NO = 'trans_NO'

airbase.cli.callback(version=<typer.models.OptionInfo object>)

Download Air Quality Data from the European Environment Agency (EEA)

Parameters:

version (bool | None) –

async airbase.cli.download(dataset, path, *, countries, pollutants, cities, metadata, country_subdir, overwrite, quiet, frequency=None, summary_only=None, year=None)

download CSV or Parquet files from corresponding API

Parameters:

• dataset (Dataset | Source) –

• path (Path) –

• countries (list[airbase.cli.Country]) –

• pollutants (list[airbase.cli.Pollutant]) –

• cities (list[str]) –

• metadata (bool) –

• country_subdir (bool) –

• overwrite (bool) –

• quiet (bool) –

• frequency (Frequency | None) –

• summary_only (bool | None) –

• year (int | None) –

Return type:

None

airbase.cli.historical(countries=<typer.models.OptionInfo object>, pollutants=<typer.models.OptionInfo object>, cities=<typer.models.OptionInfo object>, frequency=<typer.models.OptionInfo object>, metadata=<typer.models.OptionInfo object>, path=<typer.models.OptionInfo object>, summary_only=<typer.models.OptionInfo object>, country_subdir=<typer.models.OptionInfo object>, overwrite=<typer.models.OptionInfo object>, quiet=<typer.models.OptionInfo object>)

Historical Airbase data delivered between 2002 and 2012 before Air Quality Directive 2008/50/EC entered into force.

 Use -c/–country and -p/–pollutant to restrict the download specific countries and pollutants, e.g. - download only Norwegian, Danish and Finish sites

airbase download -c NO -c DK -c FI

• download only SO2, PM10 and PM2.5 observations airbase download -p SO2 -p PM10 -p PM2.5

 Use -C/–city to further restrict the download to specific cities, e.g. - download only PM10 and PM2.5 from Valletta, the Capital of Malta

airbase download -C Valletta -c MT -p PM10 -p PM2.5

Parameters:

• countries (List[Country]) –

• pollutants (List[Pollutant]) –

• cities (List[str]) –

• frequency (Frequency | None) –

• metadata (bool) –

• path (Path) –

• summary_only (bool) –

• country_subdir (bool) –

• overwrite (bool) –

• quiet (bool) –

airbase.cli.legacy(countries=<typer.models.OptionInfo object>, pollutants=<typer.models.OptionInfo object>, cities=<typer.models.OptionInfo object>, metadata=<typer.models.OptionInfo object>, path=<typer.models.OptionInfo object>, year=<typer.models.OptionInfo object>, country_subdir=<typer.models.OptionInfo object>, overwrite=<typer.models.OptionInfo object>, quiet=<typer.models.OptionInfo object>)

Air quality data in in CSV format. End of life 2024.

 The service providing air quality data in CSV format will cease operations by the end of 2024. Until then it will provide only unverified data (E2a) for 2024.

 Use -c/–country and -p/–pollutant to restrict the download specific countries and pollutants, e.g. - download only Norwegian, Danish and Finish sites

airbase download -c NO -c DK -c FI

• download only SO2, PM10 and PM2.5 observations airbase download -p SO2 -p PM10 -p PM2.5

 Use -C/–city to further restrict the download to specific cities, e.g. - download only PM10 and PM2.5 from Valletta, the Capital of Malta

airbase download -C Valletta -c MT -p PM10 -p PM2.5

Parameters:

• countries (List[Country]) –

• pollutants (List[Pollutant]) –

• cities (List[str]) –

• metadata (bool) –

• path (Path) –

• year (int) –

• country_subdir (bool) –

• overwrite (bool) –

• quiet (bool) –

airbase.cli.unverified(countries=<typer.models.OptionInfo object>, pollutants=<typer.models.OptionInfo object>, cities=<typer.models.OptionInfo object>, frequency=<typer.models.OptionInfo object>, metadata=<typer.models.OptionInfo object>, path=<typer.models.OptionInfo object>, summary_only=<typer.models.OptionInfo object>, country_subdir=<typer.models.OptionInfo object>, overwrite=<typer.models.OptionInfo object>, quiet=<typer.models.OptionInfo object>)

Unverified data transmitted continuously (Up-To-Date/UTD/E2a) data from the beginning of 2024.

 Use -c/–country and -p/–pollutant to restrict the download specific countries and pollutants, e.g. - download only Norwegian, Danish and Finish sites

airbase download -c NO -c DK -c FI

• download only SO2, PM10 and PM2.5 observations airbase download -p SO2 -p PM10 -p PM2.5

 Use -C/–city to further restrict the download to specific cities, e.g. - download only PM10 and PM2.5 from Valletta, the Capital of Malta

airbase download -C Valletta -c MT -p PM10 -p PM2.5

Parameters:

• countries (List[Country]) –

• pollutants (List[Pollutant]) –

• cities (List[str]) –

• frequency (Frequency | None) –

• metadata (bool) –

• path (Path) –

• summary_only (bool) –

• country_subdir (bool) –

• overwrite (bool) –

• quiet (bool) –

airbase.cli.verified(countries=<typer.models.OptionInfo object>, pollutants=<typer.models.OptionInfo object>, cities=<typer.models.OptionInfo object>, frequency=<typer.models.OptionInfo object>, metadata=<typer.models.OptionInfo object>, path=<typer.models.OptionInfo object>, summary_only=<typer.models.OptionInfo object>, country_subdir=<typer.models.OptionInfo object>, overwrite=<typer.models.OptionInfo object>, quiet=<typer.models.OptionInfo object>)

Verified data (E1a) from 2013 to 2023 reported by countries by 30 September each year for the previous year.

 Use -c/–country and -p/–pollutant to restrict the download specific countries and pollutants, e.g. - download only Norwegian, Danish and Finish sites

airbase download -c NO -c DK -c FI

• download only SO2, PM10 and PM2.5 observations airbase download -p SO2 -p PM10 -p PM2.5

 Use -C/–city to further restrict the download to specific cities, e.g. - download only PM10 and PM2.5 from Valletta, the Capital of Malta

airbase download -C Valletta -c MT -p PM10 -p PM2.5

Parameters:

• countries (List[Country]) –

• pollutants (List[Pollutant]) –

• cities (List[str]) –

• frequency (Frequency | None) –

• metadata (bool) –

• path (Path) –

• summary_only (bool) –

• country_subdir (bool) –

• overwrite (bool) –

• quiet (bool) –

airbase.cli.version_callback(value)

Parameters:

value (bool) –