Skip to content

lsst-tstn/tstn-001

Repository files navigation

Proposal to conduct in-house CSC development.

TSTN-001

This documents presents a proposal to, whenever possible, freeze external development of CSCs from vendors and conduct in-house development using salobj instead. Even though it may seem to be an increase of scope for the TSS software team, it is clear from our current experience that this will save the project more time in the near future.

Links

Build

This repository includes lsst-texmf as a Git submodule. Clone this repository:

git clone --recurse-submodules https://github.com/lsst-tstn/tstn-001

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 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 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.

About

Proposal to conduct in-house CSC development

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published