Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A line-transition data compression package.

Project description

repack

Repack and Compress Line-transition Data for Radiative-tranfer Calculations

Build Status PyPI GitHub

This code identifies the strong lines that dominate the spectrum from the large-majority of weaker lines. The code returns a binary line-by-line (LBL) file with the strong lines info (wavenumber, Elow, gf, and isotope ID), and an ascii file with the combined contribution of the weaker lines compressed into a continuum extinction coefficient (in cm-1 amagat-1) as function of wavenumber and temperature.

Currently available databases:

Team Members

Install

repack has been tested to work on Python 2.7, 3.6, and 3.7; and runs (at least) in both Linux and OSX. You can install repack from the terminal with pip:

# Note that on PyPI ``repack``is indexed as ``lbl-repack``:
pip install lbl-repack

Alternative (for conda users or for developers), you can directly dowload the source code and install to your local machine with the following terminal commands:

git clone https://github.com/pcubillos/repack/
cd repack
python setup.py install

Getting Started

The following example compresses the Exomol HCN line-transition data. First, download the ExoMol HCN dataset (there is no need to unzip the files):

# Download ExoMol HCN data:
wget http://exomol.com/db/HCN/1H-12C-14N/Harris/1H-12C-14N__Harris.states.bz2
wget http://exomol.com/db/HCN/1H-12C-14N/Harris/1H-12C-14N__Harris.trans.bz2
wget http://exomol.com/db/HCN/1H-12C-14N/Harris/1H-12C-14N__Harris.pf
wget http://exomol.com/db/HCN/1H-13C-14N/Larner/1H-13C-14N__Larner.states.bz2
wget http://exomol.com/db/HCN/1H-13C-14N/Larner/1H-13C-14N__Larner.trans.bz2
wget http://exomol.com/db/HCN/1H-13C-14N/Larner/1H-13C-14N__Larner.pf

Then create a repack configuration file ('repack_HCN.cfg') like this below:

[REPACK]

# Line-transition files:
lblfiles = 1H-12C-14N__Harris.trans.bz2
           1H-13C-14N__Larner.trans.bz2

# Database type [exomol, hitran, or kurucz]:
dbtype = exomol

# Output file name (without file extension):
outfile = HCN_exomol_0.3-33um_500-3000K

# Wavenumber boundaries and sampling rate (in cm-1):
wnmin =   303.0
wnmax = 33334.0
dwn   =     1.0

# Temperature sampling:
tmin  =  500.0
tmax  = 3000.0
dtemp =  100.0

# Line-intensity threshold for strong/weak lines:
sthresh = 0.1

# Maximum chunk size of lines to handle at a time:
chunksize = 15000000

And run repack, which will produce the following screen output:

# Call the repack command-line executable for the HCN demo config file:
repack repack_HCN.cfg

::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
  repack: line-transition data compression.
  Version 1.2.8.
  Copyright (c) 2017-2019 Patricio Cubillos.
  repack is open-source software under the MIT license.
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::


Starting: Sun Jul  7 19:52:28 2019
Unzipping: '1H-12C-14N__Harris.trans.bz2'.
Unzipping: '1H-13C-14N__Larner.trans.bz2'.
Reading: '1H-12C-14N__Harris.trans.bz2'.
Reading: '1H-13C-14N__Larner.trans.bz2'.
  Flagging lines at  500 K (chunk 1/5):
  Compression rate:       98.13%,    247,715/13,241,389 lines.
  Flagging lines at 3000 K:
  Compression rate:       96.17%,    506,751/13,241,389 lines.
  Total compression rate: 95.11%,    648,132/13,241,389 lines.

...

  Flagging lines at  500 K (chunk 5/5):
  Compression rate:       96.94%,    401,033/13,089,891 lines.
  Flagging lines at 3000 K:
  Compression rate:       93.09%,    904,262/13,089,891 lines.
  Total compression rate: 91.42%,  1,122,911/13,089,891 lines.

With a threshold strength factor of 0.1,
kept a total of 3,009,610 line transitions out of 65,586,274 lines.

Successfully rewriten exomol line-transition info into:
  'HCN_exomol_0.3-33um_500-3000K_lbl.dat' and
  'HCN_exomol_0.3-33um_500-3000K_continuum.dat'.
End: Sun Jul  7 19:59:59 2019

The output binary file 'HCN_exomol_0.3-33um_500-3000K_lbl.dat' contains the line-by-line opacity information for HCN, which represent most of the opacity contribution into the spectrum. The information is encoded as a sequence of three doubles and an integer containing the wavenumber (in cm-1), lower-state energy (in cm-1 units), gf value, and isotope index, respectively, for each transition. This info can be easily read with the following python script:

import repack.utils as u
wn, elow, gf, iiso = u.read_lbl('HCN_exomol_0.3-33um_500-3000K_lbl.dat')

The output ascii file 'HCN_exomol_0.3-33um_500-3000K_continuum.dat' contains the remaining opacity contribution of the weak lines (in cm-1 amagat-1 units) as function of wavenumber and temperature. This is a minor contribution compared to that of the LBL output file.

Be Kind

Please, be kind and acknowledge the effort of the authors by citing the article asociated to this project:

Cubillos (2017): An Algorithm to Compress Line-transition Data for Radiative-transfer Calculations, ApJ 850, 32.

License

Copyright (c) 2017-2019 Patricio Cubillos and contributors. repack is open-source software under the MIT license (see LICENSE).

Project details


Release history Release notifications

Download files

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

Files for lbl-repack, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size lbl-repack-1.3.0.tar.gz (58.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page