https://github.com/lsst/lse-163

LSE-163: Data Products Definition Document
https://github.com/lsst/lse-163

Last synced: about 1 year ago
JSON representation

LSE-163: Data Products Definition Document

• Host: GitHub
• URL: https://github.com/lsst/lse-163
• Owner: lsst
• Created: 2015-06-10T18:18:29.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2023-10-13T04:07:47.000Z (over 2 years ago)
• Last Synced: 2025-01-22T21:41:31.890Z (over 1 year ago)
• Language: TeX
• Homepage: https://lse-163.lsst.io
• Size: 12.9 MB
• Stars: 5
• Watchers: 13
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
.. image:: https://img.shields.io/badge/lse--163-lsst.io-brightgreen.svg

   :target: https://dmtn-163.lsst.io

.. image:: https://github.com/lsst/lse-163/workflows/CI/badge.svg

   :target: https://github.com/lsst/lse-163/actions/

#################################

Data Products Definition Document

#################################

LSE-163

=======

This document describes the data products and processing services to be delivered by the Vera C. Rubin Observatory Legacy Survey of Space and Time (LSST).

Links

=====

- Accepted version on DocuShare: http://ls.st/lse-163

- Live drafts: https://lse-163.lsst.io

- GitHub: https://github.com/lsst/lse-163

Build

=====

This repository includes lsst-texmf_ as a Git submodule.

Clone this repository::

    git clone --recurse-submodules https://github.com/lsst-dm/dmtn-165

Compile the PDF::

    make

Clean built files::

    make clean

Updating acronyms

-----------------

A table of the technote's acronyms and their definitions are maintained in the ``acronyms.tex`` file, which is committed as part of this repository.

To update the acronyms table in ``acronyms.tex``::

    make acronyms.tex

*Note: this command requires that this repository was cloned as a submodule.*

The acronyms discovery code scans the LaTeX source for probable acronyms.

You can ensure that certain strings aren't treated as acronyms by adding them to the `skipacronyms.txt <./skipacronyms.txt>`_ file.

The lsst-texmf_ repository centrally maintains definitions for LSST acronyms.

You can also add new acronym definitions, or override the definitions of acronyms, by editing the `myacronyms.txt <./myacronyms.txt>`_ file.

Updating lsst-texmf

-------------------

`lsst-texmf`_ includes BibTeX files, the ``lsstdoc`` class file, and acronym definitions, among other essential tooling for LSST's LaTeX documentation projects.

To update to a newer version of `lsst-texmf`_, you can update the submodule in this repository::

   git submodule update --init --recursive

Commit, then push, the updated submodule.

.. _lsst-texmf: https://github.com/lsst/lsst-texmf