Initial commit

.github/workflows/ci.yaml

@@ -0,0 +1,41 @@
+name: CI
+
+"on": [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # full history for metadata
+          submodules: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      - name: Python install
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install "lander<2.0.0"
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: sqrereadonly
+          password: ${{ secrets.DOCKERHUB_SQREREADONLY_TOKEN }}
+
+      - name: TeX build
+        run: |
+          docker run --rm -v `pwd`:/workspace -w /workspace lsstsqre/lsst-texmf:latest sh -c 'make'
+
+      - name: Landing page upload
+        if: ${{ github.event_name == 'push' }}
+        env:
+          LTD_PASSWORD: ${{ secrets.LTD_PASSWORD }}
+          LTD_USERNAME: ${{ secrets.LTD_USERNAME }}
+        run: |
+          lander --upload --pdf DMTR-451.pdf --lsstdoc DMTR-451.tex --ltd-product dmtr-451

.gitignore

@@ -0,0 +1,184 @@
+## Products (published by CI)
+DMTR-451.pdf
+
+# Generated by the Makefile
+meta.tex
+
+one.*
+## Core latex/pdflatex auxiliary files:
+*.aux
+*.lof
+*.log
+*.lot
+*.fls
+*.out
+*.toc
+*.fmt
+*.fot
+*.cb
+*.cb2
+
+
+## Intermediate documents:
+*.dvi
+*-converted-to.*
+
+## Bibliography auxiliary files (bibtex/biblatex/biber):
+*.bbl
+*.bcf
+*.blg
+*-blx.aux
+*-blx.bib
+*.brf
+*.run.xml
+
+## Build tool auxiliary files:
+*.fdb_latexmk
+*.synctex
+*.synctex.gz
+*.synctex.gz(busy)
+*.pdfsync
+
+## Auxiliary and intermediate files from other packages:
+# algorithms
+*.alg
+*.loa
+
+# achemso
+acs-*.bib
+
+# amsthm
+*.thm
+
+# beamer
+*.nav
+*.snm
+*.vrb
+
+# cprotect
+*.cpt
+
+# fixme
+*.lox
+
+#(r)(e)ledmac/(r)(e)ledpar
+*.end
+*.?end
+*.[1-9]
+*.[1-9][0-9]
+*.[1-9][0-9][0-9]
+*.[1-9]R
+*.[1-9][0-9]R
+*.[1-9][0-9][0-9]R
+*.eledsec[1-9]
+*.eledsec[1-9]R
+*.eledsec[1-9][0-9]
+*.eledsec[1-9][0-9]R
+*.eledsec[1-9][0-9][0-9]
+*.eledsec[1-9][0-9][0-9]R
+
+# glossaries
+*.acn
+*.acr
+*.glg
+*.glo
+*.gls
+*.glsdefs
+
+# gnuplottex
+*-gnuplottex-*
+
+# hyperref
+*.brf
+
+# knitr
+*-concordance.tex
+# TODO Comment the next line if you want to keep your tikz graphics files
+*.tikz
+*-tikzDictionary
+
+# listings
+*.lol
+
+# makeidx
+*.idx
+*.ilg
+*.ind
+*.ist
+
+# minitoc
+*.maf
+*.mlf
+*.mlt
+*.mtc
+*.mtc[0-9]
+*.mtc[1-9][0-9]
+
+# minted
+_minted*
+*.pyg
+
+# morewrites
+*.mw
+
+# mylatexformat
+*.fmt
+
+# nomencl
+*.nlo
+
+# sagetex
+*.sagetex.sage
+*.sagetex.py
+*.sagetex.scmd
+
+# sympy
+*.sout
+*.sympy
+sympy-plots-for-*.tex/
+
+# pdfcomment
+*.upa
+*.upb
+
+# pythontex
+*.pytxcode
+pythontex-files-*/
+
+# thmtools
+*.loe
+
+# TikZ & PGF
+*.dpth
+*.md5
+*.auxlock
+
+# todonotes
+*.tdo
+
+# xindy
+*.xdy
+
+# xypic precompiled matrices
+*.xyc
+
+# endfloat
+*.ttt
+*.fff
+
+# Latexian
+TSWLatexianTemp*
+
+## Editors:
+# WinEdt
+*.bak
+*.sav
+
+# Texpad
+.texpadtmp
+
+# Kile
+*.backup
+
+# KBibTeX
+*~[0-9]*

DMTR-451.tex

@@ -0,0 +1,60 @@
+\documentclass[DM,toc]{lsstdoc}
+% lsstdoc documentation: https://lsst-texmf.lsst.io/lsstdoc.html
+
+% Generated by Makefile
+\input{meta}
+
+% Package imports go here.
+
+% Local commands go here.
+
+% If you want glossaries, uncomment:
+% \input{aglossary.tex}
+% \makeglossaries
+
+\title{Characterization Metric Report: Science Pipelines Version 28.0.0}
+% \setDocSubtitle{Optional subtitle}
+
+\author{%
+Jeff Carlin
+}
+
+\setDocRef{DMTR-451}
+\setDocUpstreamLocation{\url{https://github.com/lsst-dm/DMTR-451}}
+\date{\vcsDate}
+% \setDocCurator{The Curator of this Document}
+
+\setDocAbstract{%
+Add abstract text.
+}
+
+% Revision history.
+% Order: oldest first.
+% Fields: VERSION, DATE, DESCRIPTION, OWNER NAME.
+% See LPM-51 for version number policy.
+\setDocChangeRecord{%
+  \addtohist{1}{2024-12-06}{Unreleased.}{Jeff Carlin}
+}
+
+\begin{document}
+
+\maketitle
+
+% ADD CONTENT HERE
+% You can also use the \input command to include several content files.
+
+\appendix
+
+% Include all the relevant bib files.
+% https://lsst-texmf.lsst.io/lsstdoc.html#bibliographies
+\section{References} \label{sec:bib}
+\renewcommand{\refname}{} % Suppress default Bibliography section
+\bibliography{local,lsst,lsst-dm,refs_ads,refs,books}
+
+% Make sure lsst-texmf/bin/generateAcronyms.py is in your path
+\section{Acronyms} \label{sec:acronyms}
+\input{acronyms.tex}
+% If you want glossary uncomment below and comment out the two lines above.
+% \printglossaries
+
+\end{document}

Makefile

@@ -0,0 +1,48 @@
+DOCTYPE = DMTR
+DOCNUMBER = 451
+DOCNAME = DMTR-451
+
+tex = $(filter-out $(wildcard *acronyms.tex) , $(wildcard *.tex))
+
+GITVERSION := $(shell git log -1 --date=short --pretty=%h)
+GITDATE := $(shell git log -1 --date=short --pretty=%ad)
+GITSTATUS := $(shell git status --porcelain)
+ifneq "$(GITSTATUS)" ""
+	GITDIRTY = -dirty
+endif
+
+export TEXMFHOME ?= lsst-texmf/texmf
+
+# Add aglossary.tex as a dependancy here if you want a glossary (and remove acronyms.tex)
+$(DOCNAME).pdf: $(tex) meta.tex local.bib acronyms.tex
+	latexmk -bibtex -xelatex -f $(DOCNAME)
+#	makeglossaries $(DOCNAME)
+#	xelatex $(DOCNAME)
+# For glossary uncomment the 2 lines above
+
+
+# Acronym tool allows for selection of acronyms based on tags - you may want more than DM
+acronyms.tex: $(tex) myacronyms.txt
+	$(TEXMFHOME)/../bin/generateAcronyms.py -t "DM" $(tex)
+
+# If you want a glossary you must manually run generateAcronyms.py  -gu to put the \gls in your files.
+aglossary.tex :$(tex) myacronyms.txt
+	generateAcronyms.py  -g $(tex)
+
+
+.PHONY: clean
+clean:
+	latexmk -c
+	rm -f $(DOCNAME).{bbl,glsdefs,pdf}
+	rm -f meta.tex
+
+.FORCE:
+
+meta.tex: Makefile .FORCE
+	rm -f $@
+	touch $@
+	printf '%% GENERATED FILE -- edit this in the Makefile\n' >>$@
+	printf '\\newcommand{\\lsstDocType}{$(DOCTYPE)}\n' >>$@
+	printf '\\newcommand{\\lsstDocNum}{$(DOCNUMBER)}\n' >>$@
+	printf '\\newcommand{\\vcsRevision}{$(GITVERSION)$(GITDIRTY)}\n' >>$@
+	printf '\\newcommand{\\vcsDate}{$(GITDATE)}\n' >>$@

README.rst

@@ -0,0 +1,61 @@
+.. image:: https://img.shields.io/badge/dmtr--451-lsst.io-brightgreen.svg
+   :target: https://dmtr-451.lsst.io
+.. image:: https://github.com/lsst-dm/DMTR-451/workflows/CI/badge.svg
+   :target: https://github.com/lsst-dm/DMTR-451/actions/
+
+################################################################
+Characterization Metric Report: Science Pipelines Version 28.0.0
+################################################################
+
+**DMTR-451**
+
+Links
+=====
+
+- Live drafts: https://dmtr-451.lsst.io
+- GitHub: https://github.com/lsst-dm/DMTR-451
+- Build: https://github.com/lsst-dm/DMTR-451/actions/
+
+Build
+=====
+
+This repository includes lsst-texmf_ as a Git submodule.
+Clone this repository::
+
+    git clone --recurse-submodules https://github.com/lsst-dm/DMTR-451
+
+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