Skip to content

Latest commit

 

History

History
250 lines (194 loc) · 10.4 KB

README.md

File metadata and controls

250 lines (194 loc) · 10.4 KB
Raw

SCIAMACHY 2d satellite trace gas retrieval

DOI Build Status

Two-dimensional trace gas retrieval from SCIAMACHY limb scans as described in Scharringhausen et al., 2008 (doi:10.5194/acp-8-1963-2008), Langowski et al., 2014 (doi:10.5194/amt-7-29-2014), Bender et al., 2013 (doi:10.5194/amt-6-2521-2013), Bender et al., 2017 (doi:10.5194/amt-10-209-2017).

For a more detailed history and more references, see the history.md.

This version currently supports retrieving the following species:

  • Mg
  • Mg+
  • Fe
  • NO

Prerequisites

Configuration and pre-build setup is best managed via CMake version 2.8 or higher. Other pieces needed to successfully compile the program are:

required

optional

Download

Official releases are available for download from https://github.com/st-bender/scia_retrieval_2d/releases.

To keep up with ongoing development, clone the git repository:

$ git clone https://github.com/st-bender/scia_retrieval_2d.git

If you want to contribute, fork the project on github and send pull requests for changes you made to improve the retrieval or documentation.

Compile

Out of tree builds are supported and recommended, the simplest build steps are:

$ mkdir build
$ cd build
$ cmake [OPTIONS] ..
$ make [-j <n>]

This should produce an executable called scia_retrieval in the (current) build/ subdirectory.

The cmake command above honours the following variables (defined on the command line with -D) to find libraries and include files in non-standard locations:

  • EIGEN3_INCLUDES: to find Eigen/Dense if available
  • OPENBLAS_LIBS: to find the openblas libraries if available
  • SUNPERF_LIBS: to find the sunperf libraries if available
  • NOEM_LIBS: to find the NOEM model (as a shared library) if available
  • CMAKE_LIBRARY_PATH: combined library search path (documentation), separated by semicolons (;, may have to be escaped depending on the shell)

Examples:

$ cmake -DEIGEN3_INCLUDES=/usr/include/eigen3 ..
$ cmake -DOPENBLAS_LIBS=/path/to/openblas/lib ..
$ cmake -DNOEM_LIBS=/path/to/noem/lib ..
# using CMAKE_LIBRARY_PATH
$ cmake -DCMAKE_LIBRARY_PATH=/path/to/openblas/lib\;/path/to/noem/lib ..

Install

There is no automatic install available. Simply copy the executable to a place where it is accessible, for example /usr/local/bin or ~/bin.

Usage

Preparation

Running the retrieval needs SCIAMACHY geo-located atmospheric level 1b spectra (SCI_NL__1P) (for example version 8.02) provided by ESA via the ESA data browser.

The spectra need to be calibrated first which requires two steps:

  1. Producing a .child or HDF5 (.h5) file; the first can be created for example with the SciaL1C command line tool or with the free software nadc_tools. The latter can also output to HDF5 (.h5), for example:

    $ /path/to/nadc_tools/bin/scia_nl1 -limb --cat=26,27 --channel=1 --cal=1,2,4,5+,6,7,9,E,N -hdf5 /path/to/L1b_v8.02/SCI_NL__1PYDPA.N1 --output=SCI_NL__1PYDPA.N1.ch1.h5

    (For category and cluster definitions see the nadc_tools documentation or the SciaL1C User Manual.)

  2. Extracting the limb spectra from the .child or HDF5 files to ASCII files or the special binary files used here, see mpl_binary.md. The HDF5 files can be converted for example with the sciapy python tools and the provided scia_conv_hdf5_limb.py script (after installing sciapy):

    $ python /path/to/scia_conv_hdf5_limb.py <HDF5_file> --cat 26,27 --clus 2,3,4

Orbitlist

After calibration, the orbitlist file contains the pathnames of all limb spectra belonging to one orbit. Those are typically 20--30 per orbit, depending on the chosen category (or categories) in the steps above. For example /home/user/SCIA/Spectra/orbitlists/MLT/2008/orbitlist-sb34343_scia1.dat may contain the following:

/home/user/SCIA/Spectra/MLT/channel_1_v8.02/2008/20080924/SCIA_limb_20080924_070223_1_0_34343.dat
/home/user/SCIA/Spectra/MLT/channel_1_v8.02/2008/20080924/SCIA_limb_20080924_070319_1_0_34343.dat
/home/user/SCIA/Spectra/MLT/channel_1_v8.02/2008/20080924/SCIA_limb_20080924_070415_1_0_34343.dat
...

or using the binary format:

/home/user/SCIA/Spectra/MLT/channel_1_v8.02/2008/20080924/SCIA_limb_20080924_070223_1_0_34343.dat.l_mpl_binary
/home/user/SCIA/Spectra/MLT/channel_1_v8.02/2008/20080924/SCIA_limb_20080924_070319_1_0_34343.dat.l_mpl_binary
/home/user/SCIA/Spectra/MLT/channel_1_v8.02/2008/20080924/SCIA_limb_20080924_070415_1_0_34343.dat.l_mpl_binary
...

These lists can be easily created using find, for example with:

$ find /home/user/SCIA/Spectra/MLT/channel_1_v8.02/<year>/<date>/SCIA_limb_*_<orbit>.dat > /home/user/SCIA/Spectra/orbitlists/MLT/<year>/orbitlist-sb<orbit>_scia1.dat

or:

$ find /home/user/SCIA/Spectra/MLT/channel_1_v8.02/<year>/<date>/SCIA_limb_*_<orbit>.dat.l_mpl_binary > /home/user/SCIA/Spectra/orbitlists/MLT/<year>/orbitlist-sb<orbit>_scia1.dat

with <year>, <date>, and <orbit> set appropriately.

Command line arguments

The executable scia_retrieval is invoked as follows:

$ scia_retrieval <orbitlist> <output_path> <sol_scia_orbit> <sol_ref> <script1> <script2> <config>

  • orbitlist: filename

    File containing the orbital spectra files one per line (see above).
    Example: /home/user/SCIA/Spectra/orbitlists/MLT/2008/orbitlist-sb34343_scia1.dat

  • output_path: pathname

    Path to save the result files (number densities, averaging kernels, etc.) to.
    Example: /home/user/SCIA/Retrieval/Species_2008

  • sol_scia_orbit: filename or auto

    Filename of the orbit measured solar spectrum. When set to auto, the program tries to determine the solar spectrum location from the limb spectra file names (given by the entries in the orbitlist). It then assumes that the solar spectrum is located in the same directory using the glob string SCIA_solar_*_<orbitnumber>.dat.
    Example: /home/user/SCIA/Spectra/2008/SCIA_solar_20080924_065146_D0_34343.dat

  • sol_ref: filename

    The filename of the highly resolved solar reference spectrum, for example the SAO2010 solar reference spectrum (doi:10.1016/j.jqsrt.2010.01.036), available from https://www.cfa.harvard.edu/atmosphere/links/sao2010.solref.converted
    Example: /home/user/SCIA/Spectra/SolRef/sao2010.solref.dat

  • script1: filename

    A script for combining multiple postscript or pdf files into one large pdf document. A simple approach is using ghostscript, see the multips2pdf script in the source tree.
    Example: /home/user/SCIA/run/multips2pdf

  • script2: filename

    A script for combining multiple postscript or pdf files into one large postscript document. A simple approach is using ghostscript, see the multips2ps script in the source tree.
    Example: /home/user/SCIA/run/multips2ps

  • config: filename

    Detailed retrieval configuration, see the SCIA2D_mlt.conf and SCIA2D_nom.conf files in the source tree.
    Example: /home/user/SCIA/run/SCIA2D_mlt.conf

Licenses

This program is free software: you can redistribute it or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2 (GPLv2), see local copy or online version.

Exemptions from the GPLv2 are the following parts:

  • The NRLMSISE-00 source files nrlmsise-00.c, nrlmsise-00_data.c, nrlmsise-00_doc.txt, and nrlmsise-00.h are in the public domain, see COPYING.NRLMSISE-00.
  • The gzstream source files gzstream.cpp and gzstream.h are subject to the GNU Lesser General Public License, version 2.1, see local copy or online version.

Acknowledgements

The initial FORTRAN version was developed at the University of Bremen, Germany, supported by the Air Force Office of Scientific Research (AFOSR), Air Force Material Command, USAF, under grant number FA8655-03-1-3035. The transition to C++ was developed at the University of Bremen, Germany, also supported by the AFOSR and the European Office of Aerospace Research and Development (EOARD), under grant number FA8655-09-3012. The latest version of the code was developed at the Karlsruhe Institute of Technology (KIT), Karlsruhe, Germany, supported by the Helmholtz-society under the grant number VH-NG-624.