.. highlight:: igmspec

*******
igmspec
*******

IgmSpec is the first public database available with specdb.
It provides spectra that probe the intergalactic medium
(IGM) from published datasets including SDSS,
2QZ, and data from HST, Keck, VLT, and more.

Versions
========

The datasets included in a specific version of the
`igmspec` database release are summarized below.  We
refer you to the publication
(`coming soon <http://specdb.readthedocs.io/en/latest/>`_)
and the
`igmspec documentation <http://igmspec.readthedocs.io/en/latest/>`_
for futher descriptions of the data groups.

========  ====================================================
Version   Data Groups
========  ====================================================
v01       BOSS_DR12, SDSS_DR7, KODIAQ_DR1, HD_LLS, GGG
v02       MUSoDLA, HSTQSO, COS-Dwarfs, COS-Halos, 2QZ, HDLA100
  ..      ESI-DLA, XQ-100, HST_z2, UVpSM4
========  ====================================================

Downloading
===========

Use the script `specdb_get_igmspec` to grab a copy of the database.
Here is the usage::

    usage: specdb_get_igmspec [-h] [-v VERSION]

    Grab the IGMspec DB

    optional arguments:
      -h, --help            show this help message and exit
      -v VERSION, --version VERSION
                            DB version to generate


The standard call is therefore::

    UNIX> cd where_you_want_the_DB_file
    UNIX> specdb_get_igmspec -v=v02

Setup
=====

Add to your UNIX environmental variables the path to the DB file, e.g.::

    setenv SPECDB /raid/SPECDB/   # csh or tcsh
    export SPECDB="/raid/SPECDB/" # bash


More
====

You can also view a series of examples of using the database here:
`Examples with igmspec <https://github.com/specdb/specdb/blob/master/docs/nb/Examples_with_igmspec.ipynb>`_

Other details are provided in the
`igmspec documentation <http://igmspec.readthedocs.io/en/latest/>`_.