Permalink
Fetching contributors…
Cannot retrieve contributors at this time
53 lines (32 sloc) 2.06 KB

Installing lsst-texmf

You can get the LSST LaTeX classes and style files from GitHub:

git clone https://github.com/lsst/lsst-texmf

To enable LaTeX to find the style files the :envvar:`TEXMFHOME` environment variable can be set to the :file:`texmf` subdirectory. For example, the following can be used if you are in the directory from which you cloned the repository:

export TEXMFHOME=`pwd`/lsst-texmf/texmf

A single :file:`texmf` directory can be reused for multiple documents, or else, it is possible to have separate :file:`texmf` directories for each document, having the environment variable set by a make file. A particularly useful way of doing the latter is to install :file:`lsst-texmf` as a git submodule. To do this, execute this within your document's repository:

git submodule add https://github.com/lsst/lsst-texmf

Add and commit as usual. Later, when making a fresh clone of the repository, users will have to execute this within the repository:

git submodule init
git submodule update

If you do not want to override this environment setting but wish to have the files always available you can move the entire :file:`texmf` tree to the default home location which can be found using:

kpsewhich -var-value TEXMFHOME

which on a Mac reports :file:`~/Library/texmf`.

Once this environment variable is set, :command:`xelatex` and :command:`pdflatex` will find the relevant files automatically.

Note

:command:`xelatex` is the modern version of :command:`pdflatex` that has support for more modern native fonts and Unicode. The :file:`lsstdoc.cls` class and the :file:`LSST-beamer.sty` adjust correctly when :command:`xelatex` is being used. More information on :command:`xelatex` can be found at https://en.wikipedia.org/wiki/XeTeX. Consider using :command:`xelatex` for all documents. Use the -xelatex option for the :command:`latexmk` command, rather than -pdf.