https://github.com/lsst-dm/dmtn-199
Rubin Observatory Data Security Standards Implementation
https://github.com/lsst-dm/dmtn-199
Last synced: 3 months ago
JSON representation
Rubin Observatory Data Security Standards Implementation
- Host: GitHub
- URL: https://github.com/lsst-dm/dmtn-199
- Owner: lsst-dm
- License: cc-by-4.0
- Created: 2021-07-19T16:43:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T16:13:05.000Z (6 months ago)
- Last Synced: 2025-01-12T11:15:44.346Z (4 months ago)
- Language: TeX
- Homepage: https://dmtn-199.lsst.io
- Size: 10.1 MB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://img.shields.io/badge/dmtn--199-lsst.io-brightgreen.svg
:target: https://dmtn-199.lsst.io
.. image:: https://github.com/lsst-dm/dmtn-199/workflows/CI/badge.svg
:target: https://github.com/lsst-dm/dmtn-199/actions/
DMTN-199
========
Implementation of Rubin data security standards.
Links
=====
- Live drafts: in github.
- GitHub: https://github.com/rubin-observatory/dmtn-199
Build
=====
This repository includes lsst-texmf_ as a Git submodule.
Clone this repository::
git clone --recurse-submodules https://github.com/lsst-dm/dmtn-199
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 ``aglossary.tex``::
make aglossary.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