Skip to main content

GATIAB

image image image

GATIAB (Gasous Absorption Transmissions at Instrument Averaged Bands).
This module provides gaseous transmissions base on CKDMIP idealized Look-Up tables and sensor spectral response functions.

Mustapha Moulana
HYGEOS


CKDMIP data

The CKDMIP (the Correlated K-Distribution Model Intercomparison Project) Idealized Look-Up tables are necessary to use the gatiab module. See: Hogan et al. -> https://gmd.copernicus.org/articles/13/6501/2020/

The CKDMIP documentation and data are available here: https://confluence.ecmwf.int/display/CKDMIP

AFGL atmophere LUTs

The gatiab module needs afgl atmosphere profils. Those atmophere look-up tables can be dowloaded from SMART-G (Speed-up Monte Carlo Advanced Radiative Transfer Code using GPU) -> https://github.com/hygeos/smartg

The SMART-G makefile can be used:

$ make auxdata_atm

Installation

The module can be installed using one the following commands:

$ conda install -c conda-forge gatiab
$ pip install gatiab
$ pip install git+https://github.com/hygeos/gatiab.git

Testing

Example of pytest.ini file:

[pytest]
addopts=
    --dir-ckdmip="/path/to/ckdmip/dir/"
    --dir-atm="path/to/atm/dir/"
    -s -v

Run the command pytest tests/ to check that everything is running correctly.

Exemples

from gatiab import ckdmip2od, Gatiab
import xarray as xr
import glob

# Specify the ckdmip and atmophere directory paths
dir_ckdmip = "path/to/ckdmip/dir/" 
dir_atm = "path/to/atm/dir/"

# First create optical depth LUTs of a given atmosphere
# wavenumber units -> cm-1
ds = ckdmip2od(gas='O3', dir_ckdmip=dir_ckdmip, dir_atm=dir_atm, atm='afglus',
               wvn_min = 4000., wvn_max=26000., save=True)

# Second we need the instrument spectral response
# Here we use the LUTs we have created for testing of Sentinel 3A OLCI
# Other SRF intruments -> https://nwp-saf.eumetsat.int/site/software/rttov/download/coefficients/spectral-response-functions/
rsrf_files = sorted(glob.glob("./tests/S3A_OLCI_rsrf/*.nc"))
nbands = len(rsrf_files)
rsrf = [] # iband list with relative spectral response as function of wavelength
srf_wvl = [] # iband list with wavelength in nanometer
for i in range (0, nbands):
    with xr.open_dataset(rsrf_files[i]) as ds:
        rsrf.append(ds['rsrf'].values)
        srf_wvl.append(ds['wvl'].values)

# Third compute the gas transmission as function of gas content, airmass, ground pressure and wavelength
gt = Gatiab(ds)
gt.print_gas_content() # print the standard afgl total column content of O3

gas_content = np.array([250., 300., 350.]) # in DU
air_mass = np.array([3., 4., 5.])
p0 = gt.od['P_hl'][-2:].data*1e-2 # ground pressure in hectopascal
ds_gt = gt.calc(gas_content, air_mass, p0, srf_wvl, rsrf)
print(ds_gt)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gatiab-1.1.2.tar.gz (64.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gatiab-1.1.2-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

Details for the file gatiab-1.1.2.tar.gz.

File metadata

  • Download URL: gatiab-1.1.2.tar.gz
  • Upload date:
  • Size: 64.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gatiab-1.1.2.tar.gz
Algorithm Hash digest
SHA256 147ea0bb5673a90bb45738462e11888021fd5a04ce7c4d6ead856b959e49634d
MD5 a749f4a38dc99202a480ca506499dd34
BLAKE2b-256 088c5e469e2bfe8347f4088c47873fbc19bde3d4961ce7ba756fe94c1a40a5c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for gatiab-1.1.2.tar.gz:

Publisher: push_pypi.yml on hygeos/gatiab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gatiab-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: gatiab-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gatiab-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 887d78190ab51474daad1ee4604971c90a473bc4d8b493014e488bfe13489b2e
MD5 10016b0eb655fd072190fb4207a6ba41
BLAKE2b-256 2a1d2ab1287eb464f346f3fc4d8e7c9130eb82e2942ac707e2ef63b29458b42e

See more details on using hashes here.

Provenance

The following attestation bundles were made for gatiab-1.1.2-py3-none-any.whl:

Publisher: push_pypi.yml on hygeos/gatiab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.1.2 This release

2 files

1.1.1

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page