diff --git a/SConstruct b/SConstruct index 002c0531..065e42e0 100644 --- a/SConstruct +++ b/SConstruct @@ -11,6 +11,7 @@ SConscript( "project_templates/technote_aastex/SConscript", "project_templates/technote_adasstex/SConscript", "project_templates/technote_spietex/SConscript", + "project_templates/technote_ascomtex/SConscript", "project_templates/test_report/SConscript", "project_templates/latex_lsstdoc/SConscript", "project_templates/fastapi_safir_app/SConscript", diff --git a/project_templates/technote_ascomtex/CHANGELOG.md b/project_templates/technote_ascomtex/CHANGELOG.md new file mode 100644 index 00000000..7f2de413 --- /dev/null +++ b/project_templates/technote_ascomtex/CHANGELOG.md @@ -0,0 +1,5 @@ +# Change log + +## 2024-08-30 + +Creation diff --git a/project_templates/technote_ascomtex/README.md b/project_templates/technote_ascomtex/README.md new file mode 100644 index 00000000..d40bbc4a --- /dev/null +++ b/project_templates/technote_ascomtex/README.md @@ -0,0 +1,184 @@ +# technote_aastex + +**LSST technical note repository, formatted as a AASTeX paper preprint.** + +This template generates a new paper repository based on [Elsevier cas Tex](https://mirrors.ctan.org/macros/latex/contrib/elsarticle.zip). +This template also uses bib and author metadata from [lsst-texmf](https://lsst-texmf.lsst.io). +See [Technotes for stand-alone technical documentation in the Developer Guide](https://developer.lsst.io/project-docs/technotes.html). + +## Template variables + +### cookiecutter.org + +The organization responsible for the document. + +### cookiecutter.series + +The identifier of the technote series which will be used to name the repo +Choose the series that fits the document's purpose or aligns with the organization creating the document. +For now to make this simpler we assume Papers are DMTN or PSTN. + +- `DMTN` for Data Management technical notes. +- `PSTN` for Project Science Team technical notes. +- `TSTN` for Telescope and Site Team technical notes. + +### cookiecutter.serial_number + +The serial number. Use three digits padded with zeros. +If you are creating a technical note manually with this template, see the [Create a technote](https://developer.lsst.io/project-docs/technotes.html#create-a-technote) instructions for how to determine the serial number. + +### cookiecutter.github_org + +The GitHub organization where this technote resides. +Choose a GitHub organization that matches the [series](#cookiecutter_series): + +- `lsst-dm` for the DMTN series. +- `lsst-pst` for the PSTN series. +- `lsst-ts` for the TSTN series. + +### cookiecutter.title + +The title of the technote. + +### cookiecutter.author_id + +The ID of the first author. +Author IDs may be found in the [https://github.com/lsst/lsst-texmf/blob/main/etc/authordb.yaml](authorsdb.yaml) file in lsst-texmf - this YAML database contains all LSST authors. +Additional authors can be added later in the `authors.yaml` file. +The file `authors.tex` is generated from the list of author codes in `authors.yaml`. + +### cookiecutter.abstract + +A short description of the technote's content and purpose. +This description is used in the repository's README and the abstract in the document itself. + +### cookiecutter.copyright_year + +The year of the initial copyright claim. +Cookiecutter will automatically populate the current year. + +### cookiecutter.copyright_holder + +The initial copyright holder. +See [Copyrights for LSST DM work and the COPYRIGHT file](https://developer.lsst.io/legal/copyright-overview.html) for more information. + +## Examples + +### testn-000/ + +The [testn-000](testn-000) directory is an example of a LaTeX-formatted technote. + +## Files + +## .github/workflows/ci.yaml + +Example: [.github/workflows/ci.yaml](testn-000/.github/workflows/ci.yaml). + +The GitHub Actions workflow file. +You shouldn't have to modify this file unless you have a novel preprocessing build step (see below). + +**Tip:** GitHub Actions provides a flexible Python environment. +It's likely easier to run preprocessing scripts directly from the GitHub actions environment, rather than within the lsst-texmf Docker container: + +- Install additional Python dependencies in the `Python install` step. +- Add additional bash commands for preprocessing steps to run before the `docker run` step. +- Structure your `Makefile` so that files built in advance in the GitHub actions environment are automatically used as-is by the `docker run` command. + +For more information about using the CI environment, see the [GitHub actions workflow documentation](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions). + +## .gitignore + +Example: [.gitignore](testn-000/.gitignore). + +The gitignore file ignores the built PDF product (which is persisted on LSST the Docs), as well as intermediate LaTeX build files (including `meta.tex`). +The `acronyms.tex` file is not ignored so that `make acronyms.tex` does not need to be run for every document build. + +## acronyms.tex + +Example: [acronyms.tex](testn-000/acronyms.tex). + +This file is generated and updated by the `make acronyms.tex` command. + +## authors.tex + +Example: [authors.tex](testn-000/authors.tex). + +The file `authors.tex` is generated from the list of author codes in `authors.yaml`. +This file is normally generated through the regular `make` command, but can also be regenerated individually by running `make authors.tex`. + +### COPYRIGHT + +Example: [COPYRIGHT](testn-000/COPYRIGHT). + +Record copyright claims in this file, one line per institution. +See the [copyright](../copyright) template and [Copyrights for LSST DM work and the COPYRIGHT file](https://developer.lsst.io/legal/copyright-overview.html). + +### LICENSE + +Example: [LICENSE](testn-000/LICENSE). + +Generally speaking, LSST documentation is licensed under CC-BY 4.0. +See [Licensing LSST DM source code and content](https://developer.lsst.io/legal/licensing-overview.html) in the Developer Guide for more information. + +### local.bib + +Example: [local.bib](testn-000/local.bib). + +Add BibTeX citations to this file that aren't already available in [lsst-texmf](https://lsst-texmf.lsst.io) (the [lsstbib/](#testn-000/local_bib). +See the [Updating bibliographies](https://lsst-texmf.lsst.io/developer.html#updating-bibliographies) documentation in lsst-texmf for how to migrate local bibliography data upstream into [lsst-texmf](https://lsst-texmf.lsst.io). + +### Makefile + +Example: [Makefile](testn-000/Makefile). + +The built-in targets are: + +- `make`: compiles the PDF document by running `xelatex` and `bibtex` iteratively. + This command is used by the CI environment that pushes the PDF to LSST the Docs (lsst.io). + See the [.github/workflows/ci.yaml](#githubworkflowsciyaml) file. +- `make acronyms.tex`: regenerates the [acronyms.tex](#acronymstex) file. +- `make authors.tex`: regenerates the [authors.tex](#authorstex) file. + +Add additional make targets to do preprocessing steps (such as running a Python script to generate tables or figures). + +### myacronyms.txt + +Example: [Makefile](testn-000/Makefile). + +List acronyms in this file that are not found in lsst-texmf's [lsstacronyms.txt](https://github.com/lsst/lsst-texmf/blob/main/etc/lsstacronyms.txt) or [glossary.txt](https://github.com/lsst/lsst-texmf/blob/main/etc/glossary.txt), or that have multiple definitions (put the one you want in the local `myacronyms.txt` file). + +The format for each line of this file is: + +``` +ACRONYM:Definition +``` + +For example: + +``` +MIA:Missing In Action +``` + +### README.rst + +Example: [README.rst](testn-000/README.rst). + +The README advertises the technote to GitHub visitors and provides instructions for authors. + +You can update the abstract in the README and add author instructions as necessary. + +### skipacronyms.txt + +Example: [skipacronyms.txt](testn-000/skipacronyms.txt). + +This file contains a list acronyms that should be ignored by `generateAcronyms.py` (the script behind `make acronyms.txt`). +If your document contains acronym-like strings that aren't acronyms, you can add them to `skipacronyms.txt`. + +### {{cookiecutter.series.upper()}}-{{cookiecutter.serial_number}}.tex + +Example: [TESTN-000.tex](testn-000/TESTN-000.tex) + +This file contains the content of the technote itself. +Either write directly in this file, or use the `\input` command to include content from other files. + +For more information about writing a LaTeX document with the `aastex` class file, see the [Elsvier Author Guide](https://www.elsevier.com/latex). diff --git a/project_templates/technote_ascomtex/SConscript b/project_templates/technote_ascomtex/SConscript new file mode 100644 index 00000000..ce999257 --- /dev/null +++ b/project_templates/technote_ascomtex/SConscript @@ -0,0 +1,9 @@ +from templatekit.builder import cookiecutter_project_builder + +# Run cookiecutter to generate the 'TESTN-000' report +env = Environment(BUILDERS={'Cookiecutter': cookiecutter_project_builder}) +env.Cookiecutter(AlwaysBuild(Dir('TESTN-000')), + 'cookiecutter.json', + cookiecutter_context={'series': 'TESTN', + 'github_org': 'lsst-dm', + 'author_id': 'omullanew'}) diff --git a/project_templates/technote_ascomtex/cookiecutter.json b/project_templates/technote_ascomtex/cookiecutter.json new file mode 100644 index 00000000..6505ba6c --- /dev/null +++ b/project_templates/technote_ascomtex/cookiecutter.json @@ -0,0 +1,52 @@ +{ + "org": [ + "DM", + "OPS", + "PST", + "SE" + ], + "series": [ + "DMTN", + "PSTN", + "RTN", + "SITCOMTN", + "SMTN", + "TSTN", + "TESTN" + ], + "serial_number": "000", + "github_org": [ + "lsst", + "lsst-dm", + "lsst-pst", + "lsst-sims", + "lsst-sitcom", + "lsst-sqre-testing" + + ], + "title": "Document Title", + "author_id": "ID from lsst-texmf/etc/authorsdb.yaml", + "abstract": "Abstract text.", + "copyright_year": "{% now 'utc', '%Y' %}", + "copyright_holder": [ + "Association of Universities for Research in Astronomy, Inc. (AURA)", + "Brookhaven Science Associates, LLC", + "California Institute of Technology", + "Fermi Research Alliance, LLC", + "The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory", + "The Trustees of Princeton University", + "University of Illinois Board of Trustees", + "University of Washington" + ], + "_copy_without_render": [ + "*.bib", + "*acron*", + "els*.*", + "els*.bst", + ".gitignore", + "body.tex" + ], + "_extensions": [ + "jinja2_time.TimeExtension" + ] +} diff --git a/project_templates/technote_ascomtex/templatekit.yaml b/project_templates/technote_ascomtex/templatekit.yaml new file mode 100644 index 00000000..127e3571 --- /dev/null +++ b/project_templates/technote_ascomtex/templatekit.yaml @@ -0,0 +1,61 @@ +name: "Technote (ASCOM LaTeX)" +group: "Documents" +dialog_title: "Create a paper" +dialog_fields: + - key: "title" + label: "Paper title" + placeholder: "" + hint: "Don't include the document's handle." + component: "textarea" + - key: "abstract" + label: "Abstract or description" + hint: "You can use LaTeX here." + component: "textarea" + placeholder: "" + - key: "author_id" + label: "First author's ID" + hint: "ID is a key from lsst-texmf's authors.yaml (http://ls.st/uyr)" + component: "text" + placeholder: "" + - label: "Series" + component: "select" + preset_options: + - label: "DMTN" + value: "DMTN" + presets: + series: "DMTN" + github_org: "lsst-dm" + org: "DM" + - label: "PSTN" + value: "PSTN" + presets: + series: "PSTN" + github_org: "lsst-pst" + org: "PST" + - label: "RTN" + value: "RTN" + presets: + series: "RTN" + github_org: "lsst" + org: "OPS" + - label: "SMTN" + value: "smtn" + presets: + series: "SMTN" + github_org: "lsst-sims" + org: "SE" + - label: "TSTN" + value: "tstn" + presets: + series: "TSTN" + github_org: "lsst-tstn" + org: "DM" + - label: "Test" + value: "test" + presets: + series: "TESTN" + github_org: "lsst-sqre-testing" + org: "DM" + - label: "Initial copyright holder" + key: "copyright_holder" + component: "select" diff --git a/project_templates/technote_ascomtex/testn-000/COPYRIGHT b/project_templates/technote_ascomtex/testn-000/COPYRIGHT new file mode 100644 index 00000000..3bd45d3b --- /dev/null +++ b/project_templates/technote_ascomtex/testn-000/COPYRIGHT @@ -0,0 +1 @@ +Copyright 2024 Association of Universities for Research in Astronomy, Inc. (AURA) diff --git a/project_templates/technote_ascomtex/testn-000/LICENSE b/project_templates/technote_ascomtex/testn-000/LICENSE new file mode 100644 index 00000000..2f244ac8 --- /dev/null +++ b/project_templates/technote_ascomtex/testn-000/LICENSE @@ -0,0 +1,395 @@ +Attribution 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More_considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution 4.0 International Public License ("Public License"). To the +extent this Public License may be interpreted as a contract, You are +granted the Licensed Rights in consideration of Your acceptance of +these terms and conditions, and the Licensor grants You such rights in +consideration of benefits the Licensor receives from making the +Licensed Material available under these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/project_templates/technote_ascomtex/testn-000/Makefile b/project_templates/technote_ascomtex/testn-000/Makefile new file mode 100644 index 00000000..8f526a2a --- /dev/null +++ b/project_templates/technote_ascomtex/testn-000/Makefile @@ -0,0 +1,30 @@ +DOCTYPE = TESTN +DOCNUMBER = 000 +DOCNAME = $(DOCTYPE)-$(DOCNUMBER) + +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 + +$(DOCNAME).pdf: $(tex) local.bib authors.tex + latexmk -bibtex -xelatex -f $(DOCNAME) + +authors.tex: authors.yaml + python3 $(TEXMFHOME)/../bin/db2authors.py -m "ascom" > authors.tex + +.PHONY: clean +clean: + latexmk -c + rm -f $(DOCNAME).bbl + rm -f $(DOCNAME).pdf + rm -f meta.tex + rm -f authors.tex + +.FORCE: diff --git a/project_templates/technote_ascomtex/testn-000/README.rst b/project_templates/technote_ascomtex/testn-000/README.rst new file mode 100644 index 00000000..aa2a9934 --- /dev/null +++ b/project_templates/technote_ascomtex/testn-000/README.rst @@ -0,0 +1,63 @@ +.. image:: https://img.shields.io/badge/testn--000-lsst.io-brightgreen.svg + :target: https://testn-000.lsst.io +.. image:: https://github.com/lsst-dm/testn-000/workflows/CI/badge.svg + :target: https://github.com/lsst-dm/testn-000/actions/ + +############## +Document Title +############## + +TESTN-000 +========= + +Abstract text. + +Links +===== + +- Live drafts: https://testn-000.lsst.io +- GitHub: https://github.com/lsst-dm/testn-000 + +Build +===== + +This repository includes lsst-texmf_ as a Git submodule. +Clone this repository:: + + git clone --recurse-submodules https://github.com/lsst-dm/testn-000 + +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 diff --git a/project_templates/technote_ascomtex/testn-000/TESTN-000.tex b/project_templates/technote_ascomtex/testn-000/TESTN-000.tex new file mode 100644 index 00000000..c2294094 --- /dev/null +++ b/project_templates/technote_ascomtex/testn-000/TESTN-000.tex @@ -0,0 +1,164 @@ +%% +%% Copyright 2007-2024 Elsevier Ltd +%% +%% This file is part of the 'Elsarticle Bundle'. +%% --------------------------------------------- +%% +%% It may be distributed under the conditions of the LaTeX Project Public +%% License, either version 1.3 of this license or (at your option) any +%% later version. The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3 or later is part of all distributions of LaTeX +%% version 1999/12/01 or later. +%% +%% The list of all files belonging to the 'Elsarticle Bundle' is +%% given in the file `manifest.txt'. +%% +%% Template article for Elsevier's document class `elsarticle' +%% with numbered style bibliographic references +%% SP 2008/03/01 +%% $Id: elsarticle-template-num.tex 249 2024-04-06 10:51:24Z rishi $ +%% +\documentclass[preprint,12pt]{elsarticle} + +%% Use the option review to obtain double line spacing +%% \documentclass[authoryear,preprint,review,12pt]{elsarticle} + +%% Use the options 1p,twocolumn; 3p; 3p,twocolumn; 5p; or 5p,twocolumn +%% for a journal layout: +%% \documentclass[final,1p,times]{elsarticle} +%% \documentclass[final,1p,times,twocolumn]{elsarticle} +%% \documentclass[final,3p,times]{elsarticle} +%% \documentclass[final,3p,times,twocolumn]{elsarticle} +%% \documentclass[final,5p,times]{elsarticle} +%% \documentclass[final,5p,times,twocolumn]{elsarticle} + +%% For including figures, graphicx.sty has been loaded in +%% elsarticle.cls. If you prefer to use the old commands +%% please give \usepackage{epsfig} + +%% The amssymb package provides various useful mathematical symbols +\usepackage{amssymb} +%% The amsmath package provides various useful equation environments. +\usepackage{amsmath} +\usepackage{hyperref} +%% The amsthm package provides extended theorem environments +%% \usepackage{amsthm} + +%% The lineno packages adds line numbers. Start line numbering with +%% \begin{linenumbers}, end it with \end{linenumbers}. Or switch it on +%% for the whole article with \linenumbers. +%% \usepackage{lineno} + +\journal{Astronomy and Computing} + +% Local commands go here. +\newcommand{\docRef}{TESTN-000} +\newcommand{\docUpstreamLocation}{\url{https://github.com/lsst-dm/testn-000}} + +\providecommand{\secref}[1]{Section~\ref{#1}} +\providecommand{\appref}[1]{Appendix~\ref{#1}} +\providecommand{\tabref}[1]{Table~\ref{#1}} +\providecommand{\figref}[1]{Figure~\ref{#1}} +\providecommand{\eqnref}[1]{Eq.~\ref{#1}} +\providecommand{\recref}[1]{REC-\ref{#1}} +\def\VRO{Vera C. Rubin Observatory~} +\def\RO{Rubin Observatory~} +\def\aaps{A\&AS} % Astronomy and Astrophysics Suplement +\def\aap{A\&A} % Astronomy and Astrophysics +\def\ssr{Space~Sci.~Rev.} % Space Science Reviews +\def\apj{ApJ} % Astrophysical Journal +\def\apjs{ApJS} % Astrophysical Journal Supplement +\def\aj{AJ} % Astronomical Journal +\def\mnras{MNRAS} % Monthly Notices of the RAS +\def\araa{ARA\&A} % Annual Review of Astron and Astrophys +\def\nat{Nature} % Nature +\def\apjl{ApJ} % Astrophysical Journal, Letters +\def\icarus{Icarus} % Icarus +\def\prd{Phys.~Rev.~D} % Physical Review D +\def\physrep{Phys.~Rep.} % Physics Reports +\def\pasp{PASP} % Publications of the Astronomical Society of the Pacific +\def\procspie{Proc.\ SPIE} % Proceedings of the SPIE +\newcommand{\pasa}{PASA} % Publications of the Astronomical Society of Australia +\newcommand{\ao}{Appl.~Opt.} % Applied Optics +\def\pasj{PASJ} % Publications of the Astronomical Society of Japan + +\begin{document} + +\begin{frontmatter} + +%% Title, authors and addresses + +%% use the tnoteref command within \title for footnotes; +%% use the tnotetext command for theassociated footnote; +%% use the fnref command within \author or \affiliation for footnotes; +%% use the fntext command for theassociated footnote; +%% use the corref command within \author for corresponding author footnotes; +%% use the cortext command for theassociated footnote; +%% use the ead command for the email address, +%% and the form \ead[url] for the home page: +%% \title{Title\tnoteref{label1}} +%% \tnotetext[label1]{} +%% \author{Name\corref{cor1}\fnref{label2}} +%% \ead{email address} +%% \ead[url]{home page} +%% \fntext[label2]{} +%% \cortext[cor1]{} +%% \affiliation{organization={}, +%% addressline={}, +%% city={}, +%% postcode={}, +%% state={}, +%% country={}} +%% \fntext[label3]{} +\input{authors} +\date{\today} +\title{Document Title} + +% This can write metadata into the PDF. +% Update keywords and author information as necessary. +\hypersetup{ + pdftitle={Document Title}, + pdfauthor={omullanew}, + pdfkeywords={} +} + +\input{abstract} + +\begin{keyword} +Vera C. Rubin Observatory +%% keywords here, in the form: keyword \sep keyword + +%% PACS codes here, in the form: \PACS code \sep code + +%% MSC codes here, in the form: \MSC code \sep code +%% or \MSC[2008] code \sep code (2000 is the default) + +\end{keyword} + +\end{frontmatter} + + +\input{body} + +%% For citations use: +%% \cite{