Skip to content

Commit b330f86

Browse files
aureliocarneroaureliocarnero
committed
Starting of LSS documentation for DRs
1 parent 6684057 commit b330f86

File tree

9 files changed

+104
-1
lines changed

9 files changed

+104
-1
lines changed

‎doc/DESI_ROOT/survey/catalogs/RELEASE/LSS/SPECPROD/LSScats/VERSION/hpmaps/index.rst

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
======
2+
hpmaps
3+
======
4+
5+
Healpix maps
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
{TARGET}_mapprops_healpix_nested_nside256_{NS}.fits : by TARGET TYPE and equatorial region (N, north and S, south) <mapprops_healpix_nested_nside256>

‎doc/DESI_ROOT/survey/catalogs/RELEASE/LSS/SPECPROD/LSScats/VERSION/index.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. _clustering:
2+
3+
=======
4+
VERSION
5+
=======
6+
7+
VERSION contains the final LSS catalogs, separated by target types (:ref:`see here for references<lsscats>`), that have been prepared to be used directly to obtain clustering statistics. It includes both data for randoms (separated into 18 files given ``{RANN}``).
8+
9+
We can also found healpix maps representing several quantities under hpmaps directory for each target separately.
10+
11+
Descriptions on how to use these to obtain clustering measurements are fully given in `Ross et al. (2024)`_. Any cuts applied to the data catalogs should be equally applied to the random catalogs.
12+
13+
Any number of the random catalogs, ``{RANN}`` can be used (with the impact only on statistical precision). Large-scale clustering measurements can be accurately obtained via the columns :py:attr:`RA`, :py:attr:`DEC`, :py:attr:`Z`, :py:attr:`WEIGHT`.
14+
15+
.. _Ross et al. (2024): https://arxiv.org/abs/2405.16593
16+
17+
.. toctree::
18+
:maxdepth: 1
19+
20+
hpmaps/index

‎doc/DESI_ROOT/survey/catalogs/RELEASE/LSS/SPECPROD/LSScats/VERSIONpip/index.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
==========
2+
VERSIONpip
3+
==========
4+
5+
VERSIONpip contains same catalogs as VERSION, but with PIP weights. Healpix maps are the same and are found in the other directory
6+
7+
.. toctree::
8+
:maxdepth: 1
9+

‎doc/DESI_ROOT/survey/catalogs/RELEASE/LSS/SPECPROD/LSScats/index.rst

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
=======
2+
LSScats
3+
=======
4+
5+
``${DESI_ROOT}/survey/catalogs/RELEASE/LSS/SPECPROD/LSScats`` separate different versions of the final clustering catalogs, depending on progressive improvements of the reduction pipeline. Several versions can be found for the same RELEASE. Also, we can also found alternative completeness weights using PIP weights, substituing the standard completeness weights, in different directories with the ``pip`` suffix.
6+
7+
In order to know which version you need to use, please check DESI publications.
8+
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
VERSION/index
14+
VERSIONpip/index

‎doc/DESI_ROOT/survey/catalogs/RELEASE/LSS/SPECPROD/index.rst

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
========
2+
SPECPROD
3+
========
4+
5+
``${DESI_ROOT}/survey/catalogs/RELEASE/LSS/SPECPROD`` contains initial compacted files that reads from fiber assigment and spectroscopic reduction data, separated by PHOTSYS (``bright`` and ``dark``). Also compiled initial files separated by target types BGS_ANY, BGS_BRIGHT (for PHOTSYS = bright), LRG, ELG_LOPnotqso, QSO (for PHOTSYS = dark), as well as the end-products LSS catalogs (``LSScats``) and initial processed random catalogs (18 realizations).
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
LSScats/index
11+
rancomb_{RANN}{PHOTSYS}wdupspec_zdone.fits : Initial randoms associated with a given PHOTSYS with RANN from 0 to 17 (both included) <rancomb_wdupspec_zdone>
12+
unique_badfibers.txt : List of bad fibers for the given release <unique_badfibers>
13+
emlin_catalog.fits : Emission lines catalogs used in the spectroscopic reduction version (SPECPROD) <emlin_catalog>
14+
datcomb_{PHOTSYS}_spec_zdone.fits : Compacted catalog file of all fiber assigments <datcomb_photsys_spec>
15+
datcomb_{PHOTSYS}_zmtl_zdone.fits : Compacted catalog file of redshift fitting after spectroscopic reduction <datcomb_photsys_zmtl>
16+
datcomb_{TARGET}_tarspecwdup_zdone.fits : Merged files separated per TARGET type reached by fibers <datcomb_tarspecwdup_zdone>

‎doc/DESI_ROOT/survey/catalogs/RELEASE/LSS/index.rst

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
===
2+
LSS
3+
===
4+
5+
``${DESI_ROOT}/survey/catalogs/RELEASE/LSS`` host the LSS catalogs tagged by the spectroscopic production used (SPECPROD), named after mountains, e.g. “iron” for DR1. Normally, we will publish just one SPECPROD per data release.
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
SPECPROD/index

‎doc/DESI_ROOT/survey/catalogs/RELEASE/index.rst

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
=======
2+
RELEASE
3+
=======
4+
5+
``${DESI_ROOT}/survey/catalogs/RELEASE`` contains the LSS catalogs for bright (BGS) and dark (LRG, ELG, QSO) used for clustering analysis. The value of ``RELEASE`` will be ``dr1`` or ``dr3``, and so on.
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
LSS/index

‎doc/DESI_ROOT/survey/catalogs/index.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
========
2+
catalogs
3+
========
4+
5+
``${DESI_ROOT}/survey/catalogs`` contains the main DESI LSS catalogs, used to measure the BAO and constrain cosmology. These are associated
6+
with a specific ``RELEASE`` such as Data Release 1 (DR1) or the future DR3.
7+
8+
Subdirectories:
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
RELEASE/index

‎doc/DESI_ROOT/survey/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
survey
33
======
44

5-
``${DESI_ROOT}/survey`` contains data related to daily operations, fiberassignment, etc.
5+
``${DESI_ROOT}/survey`` contains data related to daily operations, fiberassignment and LSS catalogs.
66

77
Subdirectories:
88

99
.. toctree::
1010
:maxdepth: 1
1111

1212
fiberassign/index
13+
catalogs/index

0 commit comments

Comments
 (0)