lsstdesc / desc-tex

LaTeX support files for writing DESC papers

desc-tex

This repository contains supporting files to aid writing LSST DESC papers in LaTeX. Requests and suggestions should be raised in the issues.

Below:

• What's here
• Using DESC macros (lsstdesc_macros.sty)
• Using the DESC standard acknowledgements
• Using the DESC Note class
• Using the DESC bibliography
• How to incorporate the desc-tex repo into other projects
• Acknowledgements

What's here

• ack/ contains the standard portion of the Acknowledgements sections of DESC Key and Standard papers.
• bib/lsstdesc.bib will provide a bibliography of DESC papers, to facilitate citing them
• bst/ contains bibliography styles for common journals
• logos/ contains graphics used in the DESC Note class
• styles/ contains class and style files for common journals, the DESC Note class, and useful macros in lsstdesc_macros.sty
• test/ tests of the bibliography and macros

Using DESC macros (lsstdesc_macros.sty)

\usepackage{desc-tex/styles/lsstdesc_macros}

One of the tests produces a PDF showing how the macros compile. This may be useful.

Using the DESC standard acknowledgements

E.g. \input{desc-tex/ack/standard}. Note that these files contain only the "standard wording" part of the acknowledgements; specific acknowledements for funding agencies, software, etc. associated with a given paper should still be included (see ack/README.md).

Using the DESC Note and other classes

Via \documentclass. For Notes, see the example in the styles README. In general, be aware that these classes may rely on other LaTeX packages/infrastructure that is not included with desc-tex.

Using the DESC bibliography

\bibliography{desc-tex/bib/lsstdesc[,other .bib file(s)]}

Note that, currently, we plan on including only DESC papers in lsstdesc.bib.

How to incorporate the desc-tex repo into other projects

If your paper is not in a Git repo

Clone desc-tex as normal: git clone [email protected]:LSSTDESC/desc-tex.git

If you later git init to turn your project into a repository, it shouldn't be necessary to remove desc-tex first. After creating the repo, just run the submodule add command as in the next case, and git will figure out that desc-tex is already present, and simply register it.

To add desc-tex to a paper in a Git repo

Add desc-tex as a submodule: git submodule add [email protected]:LSSTDESC/desc-tex.git. The desc-tex folder now operates as its own independent repository; the parent repository is aware of it and tracks what state desc-tex is in, but does not actually version its files. You can interact with desc-tex in the usual way when it is the working directory, e.g. to update it: cd desc-tex; git pull.

If you have cloned a repo that includes desc-tex as a submodule

If you used the --recursive flag when cloning, everything will be set up. Otherwise, you will see an empty desc-tex/ folder. Run git submodule update --init. Thereafter, everything behaves as in the case above.

Getting desc-tex without using Git

Standalone deployment of desc-tex is possible by clicking the "Clone or download" button at the top right of this page and selecting "Download ZIP". This can also be automated deployment using the deploy_from_github_zip.bash script, as in

bash ./deploy_from_github_zip.bash desc-tex LSSTDESC/desc-tex master

This method is useful, for example, for writing papers in Overleaf, since Overleaf does not support git submodules.

Acknowledgements

Much of the material in desc-tex was cruelly appropriated from start_paper, which was developed by

• Phil Marshall
• Alex Drlica-Wagner
• Heather Kelly
• Jonathan Sick

The DESC Note class is maintained by Alex Drlica-Wagner and Phil Marshall.

Otherwise, this project is currently the responsibility of the DESC Publications Board:

• Seth Digel (Publication Manager)
• Pierre Astier
• David Kirkby
• Rachel Mandelbaum
• Adam Mantz
• Phil Marshall
• Hiranya Peiris
• Michael Wood-Vasey

desc-tex's Issues

bibtex for LSST products (from [start paper](https://github.com/LSSTDESC/start_paper/issues/72))

This continues the issue in start_paper (which I will close) here following advice from @abmantz of getting documents such as the LSST data products definition documents into the bibtex. As @drphilmarshall suggested in that issue, it might be good directly keep lsstdesc.bibtex for desc documents, and a separate bibtex file for project documents. Further, he points out that it is good to be able to use a project supplied bibtex rather than roll our own.

So, looking into this, there seems to be:

• the LSSTReferences repository and bibtex that seems most suitable for this.
• From past rummages, I also recall one being used in the overview paper. Perhaps, we can find out from someone like @timj if the first one is the best for this?

arcmin and arcsec macros

Do we need these? Are they actually special characters?

Winter 2018 hacks

Please reply to this issue with wants/needs related to desc-tex or start_paper. You can see existing issues for these projects here and here.

Don't be afraid to repeat something that is already an issue; this list is intended to identify high priority things that we might be able to make progress on during the hack day.

Similarly, new requests identified here should still be issued in the usual way. Regardless, it would be nice to link to an Issue in replies below.

More readable math font

The default in lsstdescnote.cls is not good, it has been reported... Currently we usepackage{helvet,mathpple}, should be easy to use the default latex math font.

section numbering in Notes

Some users would like sections in Notes to be numbered, especially when using a ToC. See here for a solution. However, ideally, we could make this an option to the class instead of something that requires modifying the class file.

References broken

The CLMM and PLAsTiCC results teams encountered a problem with desc-tex Overleaf integration (set up using instructions on the start-paper repo in which references to bibliography entries as well as labeled figures/sections render as question marks. I was able to reproduce the behavior locally, but the error message is uninformative beyond confirming that there is a catastrophic problem with references. It does not happen with papers built off old versions of start-paper (e.g. qp and PZ DC1). Unfortunately, the Makefile from the papers built off older versions of start-paper does not fix the papers built off newer versions of start-paper due to changes in the handling of authors and the default directory structure, which also cause the new Makefile to break papers built off older versions of start-paper before even getting to the bug in question. Would someone mind looking into this? Thanks.

Standalone deployment

To work with Overleaf (which doesn't allow submodules) it would be useful to support standalone deployent, i.e. through deploy_from_github_zip.bash from start_paper. In theory, I think everything is setup to do this with:

bash ./deploy_from_github_zip.bash desc-tex LSSTDESC/desc-tex master

However, I get the error message:

--2017-09-01 13:36:29--  https://github.com/LSSTDESC/desc-tex/archive/master.zip
Resolving github.com... 192.30.253.112, 192.30.253.113
Connecting to github.com|192.30.253.112|:443... connected.
HTTP request sent, awaiting response... 404 Not Found
2017-09-01 13:36:30 ERROR 404: Not Found.

I think this is related to the fact that desc-tex is a private repo. @abmantz @drphilmarshall is there any reason to keep desc-tex private?

Solar and stellar unit formatting?

Solar and stellar units (i.e., \Msolar, \Mstar, \Lsolar, \Lstar, and associated aliases) are currently italicized. I think they probably shouldn't be, but I thought maybe @sethdigel or @abmantz might have a more definitive answer.

Should desc-tex ship with revtex4.1?

See subject. I don't know...

create a demo pdf showing what each macro compiles to

replace start_paper README

HTML bibliography needs to handle LaTeX specials

E.g. the end of this thread

Update `lsstdesc.bib` with more 2018 papers

I'm updating the public webpages, so want to get our bib file updated to match. Watch out for a simple one-file PR!

LSST references

From discussions with @abmantz and @drphilmarshall in LSSTDESC/start_paper#72

I believe this is the repository that is used through submodule to provide general references for DESC. I do obtain the lsstdesc.bib file. However, I am trying to refer to things that are cited here for example the MAF framework. These are not included in the lsstdesc.bib yet.

I could include them in the bib file and PR this repo. Or maybe there is a plan to include those files through some other sub-modulling (but this might be hard as the files there have some different conventions and repeats). Any suggestions?

Fix aastex61 first page problems

Hack aastex61 to use better spacing. This is detailed in AASJournals/AASTeX60#38 and AASJournals/AASTeX60#42 and has been migrated from LSSTDESC/start_paper#57.

A&A template?

Are there plans to support the A&A format for docswitch? If not, @cavestruz and I would like to formally request that. Thanks!

documentation for docswitch

Some basic instructions in styles/README.md, if you have a chance, @kadrlica

Use a serif font for latex documents

Transfered over from LSSTDESC/start_paper#73

@ehneilsen writes:

While sans serif is great on overheads and documents to be read on low resolution screens, it is harder to read and can look unprofessional when used in a printed technical or scientific document. Can we replace the sans font in the latex style with a serif one?