<commit_before>===============
truth-\*.fits
===============

General Description
===================

Summary
-------

DESI Truth files contain a single binary table covering the entire footprint.  
They contain the variables that define the procedence of a target and its 
true properties. This file goes together with a mock target catalog.


Naming Convention
-----------------

TBD, let's try ``truth-{version}.fits`` where ``version`` is the code version
that wrote this, preferably a git tag of desitargets.

regex: ``truth-v?[0-9]+\.[0-9]+(\.[0-9]+|)\.fits``

Contents
========

====== ======= ======== ===================
Number EXTNAME Type     Contents
====== ======= ======== ===================
HDU0_          IMAGE    Blank
HDU1_  TRUTH   BINTABLE Truth table
====== ======= ======== ===================


FITS Header Units
=================

HDU0
----

Empty header.

HDU1
----

TRUTH.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~

======== ======================================================== ==== ===================================
KEY      Example Value                                            Type Comment
======== ======================================================== ==== ===================================
EXTNAME  TRUTH                                                    str  name of this binary table extension
DEPNAM00 desitarget                                               str
DEPVER00 0.1.0                                                    str  desitarget.__version__
DEPNAM01 desitarget-git                                           str
DEPVAL01 0.1.0                                                    str  git revision
DEPNAM02 mock-files                                               str
DEPVER02 /global/project/projectdirs/desi/mocks/preliminary       str  input directory
======== ======================================================== ==== ===================================

Required Data Table Columns
~~~~~~~~~~~~~~~~~~~~~~~~~~~

===================== ========== ===== ===================
Name                  Type       Units Description
===================== ========== ===== ===================
TARGETID              int64            ID (unique to file and the whole survey)
BRICKNAME             char[8]          Brick name from tractor input
RA                    float64          Right ascension [degrees]
DEC                   float64          Declination [degrees]
TRUEZ                 float64          True redshift in mock catalog (with peculiar velocity)
TRUETYPE              char[10]         True object type in mock catalog
===================== ========== ===== ===================


Notes and Examples
==================
<commit_msg>making a meaningless change to show ADM stuff<commit_after>===============
truth-\*.fits
===============

General Description
===================

Summary
-------

DESI Truth files contain a single binary table covering the entire footprint.  
They contain the variables that define the procedence of a target and its 
true properties. This file goes together with a mock target catalog.


Naming Convention
-----------------

TBD, let's try ``truth-{version}.fits`` where ``version`` is the code version
that wrote this, preferably a git tag of desitargets.

regex: ``truth-v?[0-9]+\.[0-9]+(\.[0-9]+|)\.fits``

Contents
========

====== ======= ======== ===================
Number EXTNAME Type     Contents
====== ======= ======== ===================
HDU0_          IMAGE    Blank
HDU1_  TRUTH   BINTABLE Truth table
====== ======= ======== ===================


FITS Header Units
=================

HDU0
----

Empty header.

HDU1
----

TRUTH.

Required Header Keywords
~~~~~~~~~~~~~~~~~~~~~~~~

======== ======================================================== ==== ===================================
KEY      Example Value                                            Type Comment
======== ======================================================== ==== ===================================
EXTNAME  TRUTH                                                    str  name of this binary table extension
DEPNAM00 desitarget                                               str
DEPVER00 0.1.0                                                    str  desitarget.__version__
DEPNAM01 desitarget-git                                           str
DEPVAL01 0.1.0                                                    str  git revision
DEPNAM02 mock-files                                               str
DEPVER02 /global/project/projectdirs/desi/mocks/preliminary       str  input directory
======== ======================================================== ==== ===================================

Required Data Table Columns
~~~~~~~~~~~~~~~~~~~~~~~~~~~

===================== ========== ===== ===================
Name                  Type       Units Description
===================== ========== ===== ===================
TARGETID              int64            ID (unique to file and the whole survey)
BRICKNAME             char[8]          Brick name from tractor input
RA                    float64          Right ascension [degrees]
DEC                   float64          Declination [degrees]
TRUEZ                 float64          True redshift in mock catalog (including peculiar velocity)
TRUETYPE              char[10]         True object type in mock catalog
===================== ========== ===== ===================


Notes and Examples
==================

{'fraction_non_alphanumeric': 0.3110704483074108, 'fraction_numerical': 0.014272644098810613, 'mean_word_length': 2.1964912280701756, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 28, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1327513', 'n_tokens_mistral': 1248, 'n_tokens_neox': 1076, 'n_words': 367}