diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..5f04358 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,51 @@ +name: CI + +"on": + push: + branches-ignore: + # These should always correspond to pull requests, so ignore them for + # the push trigger and let them be triggered by the pull_request + # trigger, avoiding running the workflow twice. This is a minor + # optimization so there's no need to ensure this is comprehensive. + - "dependabot/**" + - "renovate/**" + - "tickets/**" + - "u/**" + tags: + - "*" + pull_request: {} + +jobs: + lint: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Run pre-commit hooks + uses: pre-commit/action@v3.0.0 + + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Run tox + uses: lsst-sqre/run-tox@v1 + with: + python-version: "3.11" + tox-envs: "html" + + - name: Upload to LSST the Docs + uses: lsst-sqre/ltd-upload@v1 + with: + project: "dp0" + dir: "_build/html" + username: ${{ secrets.LTD_USERNAME }} + password: ${{ secrets.LTD_PASSWORD }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a9a0bfb --- /dev/null +++ b/.gitignore @@ -0,0 +1,160 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..c28d0f5 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,15 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: trailing-whitespace + - id: check-yaml + - id: check-json + - id: check-toml + + - repo: https://github.com/asottile/blacken-docs + rev: 1.16.0 + hooks: + - id: blacken-docs + additional_dependencies: [black] + args: [-l, "79", -t, py311] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7416b6f --- /dev/null +++ b/LICENSE @@ -0,0 +1,386 @@ +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/Makefile b/Makefile new file mode 100644 index 0000000..cb198a3 --- /dev/null +++ b/Makefile @@ -0,0 +1,31 @@ +.PHONY: help +help: + @echo "Please use \`make ' where is one of:" + @echo " init to initialize a dev environment" + @echo " html run the documentation build" + @echo " linkcheck validate links in the documentation" + @echo " lint run pre-commit linters" + @echo " clean clear tox environments and builds" + +.PHONY: init +init: + pip install -U tox pre-commit + rm -rf .tox + pre-commit install + +.PHONY: html +html: + tox run -e html + +.PHONY: linkcheck +linkcheck: + tox run -e linkcheck + +.PHONY: lint +lint: + tox run -e lint + +.PHONY: clean +clean: + rm -rf _build/* + rm -rf .tox diff --git a/README.md b/README.md index ec2b518..a295ef1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # The Data Preview 0 documentation This is the source repository for the DP0 documentation, https://dp0.lsst.io. + +## Building the documentation + +This is a [Sphinx](https://www.sphinx-doc.org/en/master/) documentation site, built with Rubin Observatory's [Documenteer user guide](https://documenteer.lsst.io/guides/index.html) configuration. + +To set up a local build environment, clone this repository: + +```bash +git clone https://github.com/lsst/dp0_lsst_io +cd dp0_lsst_io +``` + +Then, initialize the dependencies: + +```bash +make init +``` + +To build the documentation: + +```bash +make html +``` diff --git a/conf.py b/conf.py new file mode 100644 index 0000000..e127d9b --- /dev/null +++ b/conf.py @@ -0,0 +1,7 @@ +from documenteer.conf.guide import * # noqa: F401 F403 + +exclude_patterns.extend( # noqa: F405 + [ + "_static/*.txt", + ] +) diff --git a/docs/_static/DP0_Virtual_Summer_School_agenda.pdf b/docs/_static/DP0_Virtual_Summer_School_agenda.pdf new file mode 100644 index 0000000..002c0d7 Binary files /dev/null and b/docs/_static/DP0_Virtual_Summer_School_agenda.pdf differ diff --git a/docs/_static/vss_agenda.txt b/docs/_static/vss_agenda.txt new file mode 100644 index 0000000..3f6dba3 --- /dev/null +++ b/docs/_static/vss_agenda.txt @@ -0,0 +1,183 @@ +Agenda for Data Preview 0 Virtual Summer School 2023 + +Mon, Jun 12, 2023, Accessing Rubin Catalogs (TAP) + +Session A +08:00 - 08:10 +welcome +announcements +troubleshooting + +08:10 - 09:00 +Notebook 01: Introduction to DP0.2 +Portal 01: Bright Stars Color-Magnitude Diagram + +09:00 - 09:10 +break + +09:10 - 10:00 +Notebook 02: Catalog Queries with TAP + +10:00 - 10:10 +break + +10:10 - 11:00 +collaborative session + +Session B +19:00 - 19:10 +welcome +announcements +troubleshooting + +19:10 - 20:00 +Notebook 01: Introduction to DP0.2 +Notebook 06a: Interactive Image Visualization + +20:00 - 20:10 +break + +20:10 - 21:00 +collaborative session + +Tue, June 13 - Accessing Rubin Images + +Session A +08:00 - 08:10 +welcome +announcements +troubleshooting + +08:10 - 09:00 +Notebook 03a: Image Display and Manipulation +Notebook 03b: Image Display with Firefly + +09:00 -09:10 +break + +9:10 - 10:00 +Notebook 06b: Interactive Catalog Visualization + +10:00 - 10:10 +break + +10:10 - 11:00 +collaborative session + +Session B +19:00 - 19:10 +welcome +announcements +troubleshooting + +19:10 - 20:00 +Portal 02: Explore a SNIa Lightcurve +Portal 03: View a SNIa Host Galaxy + +20:00 - 20:10 +break + +20:10 - 21:00 +collaborative session + +Wed, June 14 - Using the Butler +Session A +08:00 - 08:10 +welcome +announcements +troubleshooting + +08:10 - 09:00 +Notebook 04a: Introduction to the Butler +Notebook 04b: Intermediate Butler Queries + +09:00 - 09:10 +break + +09:10 - 10:00 +Notebook 05: Introduction to Source Detection + +10:00 - 10:10 +break + +10:10 - 11:00 +collaborative session + +Session B +19:00 - 19:10 +welcome +announcements +troubleshooting + +19:10 - 20:00 +Notebook 04a: Introduction to the Butler +Notebook 04b: Intermediate Butler Queries + +20:00 - 20:10 +break + +20:10 - 21:00 +collaborative session + +Thu, June 15 - Explore Time-Domain with Rubin + +Session A +08:00 -08:10 +welcome +announcements +troubleshooting + +08:10 - 09:00 +Portal 02: Explore a SNIa Lightcurve +Portal 03: View a SNIa Host Galaxy + +09:00 - 09:10 +break + +09:10 - 10:00 +Notebook 07a: DiaObject Samples + +10:00 - 10:10 +break + +10:10 - 11:00 +collaborative session + +Session B +19:00 - 19:10 +welcome +announcements +troubleshooting + +19:10 - 20:00 +Notebook 07b: Variable Star Lightcurves + +20:00 - 20:10 +break + +20:10 - 21:00 +collaborative session + +Fri, June 16 - Science Explorations +Session A +08:00 - 08:10 +welcome +announcements +troubleshooting + +08:10 - 09:00 +Notebook 07b: Variable Star Lightcurves + +09:00 - 09:10 +break + +09:10 - 10:00 +Notebook 08: Truth Tables + +10:00 - 10:10 +break + +10:10 - 11:00 +collaborative session + +There was no Session B on Friday. diff --git a/docs/delegate-resources/assembly-recordings.rst b/docs/delegate-resources/assembly-recordings.rst new file mode 100644 index 0000000..3089987 --- /dev/null +++ b/docs/delegate-resources/assembly-recordings.rst @@ -0,0 +1,102 @@ +.. Review the README on instructions to contribute. +.. Review the style guide to keep a consistent approach to the documentation. +.. Static objects, such as figures, should be stored in the _static directory. Review the _static/README on instructions to contribute. +.. Do not remove the comments that describe each section. They are included to provide guidance to contributors. +.. Do not remove other content provided in the templates, such as a section. Instead, comment out the content and include comments to explain the situation. For example: + - If a section within the template is not needed, comment out the section title and label reference. Do not delete the expected section title, reference or related comments provided from the template. + - If a file cannot include a title (surrounded by ampersands (#)), comment out the title from the template and include a comment explaining why this is implemented (in addition to applying the ``title`` directive). + +.. This is the label that can be used for cross referencing this file. +.. Recommended title label format is "Directory Name"-"Title Name" -- Spaces should be replaced by hyphens. +.. _DP0-Delegate-Assemblies-0722-0723: +.. Each section should include a label for cross referencing to a given area. +.. Recommended format for all labels is "Title Name"-"Section Name" -- Spaces should be replaced by hyphens. +.. To reference a label that isn't associated with an reST object such as a title or figure, you must include the link and explicit title using the syntax :ref:`link text `. +.. A warning will alert you of identical labels during the linkcheck process. + + +#################################################### +Delegate Assembly Recordings, July 2022 to July 2023 +#################################################### + +.. This section should provide a brief, top-level description of the page. + +These assemblies were all focused on the DP0.2 data set. + +.. list-table:: Schedule and planned content of DP0 Delegate Assemblies + :header-rows: 1 + :widths: 1 2 2 + + * - Date + - First Hour + - Second Hour + * - 2022-07-08 + - `DP0.2 Kick-Off Info Session `__ (beginner) + - `Introduction to the DP0.2 Time-Domain Data Products `__ (intermediate) + * - 2022-07-22 + - `Catalog Data with the TAP Service `__ (beginner) + - `Time-Domain Catalogs in the TAP Service `__ (intermediate) + * - 2022-08-05 + - `Visualizing Image Data `__ (beginner) + - general Q&A; extended Firefly demo; template contamination & nuclear transients; and making scientifically useful RGB images + * - 2022-08-19 + - `Data Access with the Butler `__ (beginner-intermediate) + - general Q&A + * - 2022-09-02 + - NO ASSEMBLY (long weekend) + - *none* + * - 2022-09-16 + - `Source Detection and Measurement `__ (beginner) + - *breakouts* + * - 2022-09-30 + - `Data Visualization `__ (beginner) + - *breakouts* + * - 2022-10-14 + - `Survey Property Maps by Martín Rodríguez Monroy `__ + - *breakouts* + * - 2022-10-28 + - `Nuclear Transients by Decker French & Forced Photometry by Brian Morsony `__ + - *breakouts* + * - 2022-11-18 + - `Analysis of DIA sources by Vincenzo Petrecca `__ + - *breakouts* + * - 2022-12-09 + - `DP0 2022 Year In Review with Delegate Flash Talks! `__ + - *breakouts* + * - 2023-01-20 + - `Stellar Classification by Bob Abel `__ + - Continued stellar classification discussions. General Q&A. + * - 2023-02-03 + - `Milky Way halo science (Jeff Carlin) `__ + - *breakouts* + * - 2023-02-17 + - `Truth data (Jeff Carlin & Melissa Graham) `__ + - *breakouts* + * - 2023-03-03 + - Account setup in the RSP's new identity management system + - *breakouts* + * - 2023-03-17 + - `Time domain science (Ryan Lau) `__ + - *breakouts* + * - 2023-03-31 + - `Deblender Data Products (Christina Williams) `__ + - *breakouts* + * - 2023-04-14 + - `Variability in YSOs (Sabina Ustamujic) `__ + - *breakouts* + * - 2023-04-28 + - `Dan Ryczanowski (30 min; "Lensed Explosive Transients with DP0.2") and Antonio Vanzanella (15 min; "Finding long-period Solar System or interstellar objects with machine learning in LSST.") `__ + - *breakouts* + * - 2023-05-12 + - 23A Meeting of the `Rubin Users Committee `__ + - *breakouts* + * - 2023-05-26 + - `ChatGPT & Jupyter Notebooks (Allan Jackson) `__ + - *breakouts* + * - 2023-06-09 + - `Portal Tutorial 04 (histograms) and Portal 05 (multi-band light curves) (Greg Madejski) `__ + - *breakouts* + * - 2023-07-21 + - Inserting Kilonovae into DP0.2 Images (Matt Wiesner) + - *breakouts* + diff --git a/docs/delegate-resources/dp0-delegate-assemblies-schedule.inc b/docs/delegate-resources/dp0-delegate-assemblies-schedule.inc new file mode 100644 index 0000000..6807696 --- /dev/null +++ b/docs/delegate-resources/dp0-delegate-assemblies-schedule.inc @@ -0,0 +1,68 @@ +.. Review the README on instructions to contribute. +.. Review the style guide to keep a consistent approach to the documentation. +.. Static objects, such as figures, should be stored in the _static directory. Review the _static/README on instructions to contribute. +.. Do not remove the comments that describe each section. They are included to provide guidance to contributors. +.. Do not remove other content provided in the templates, such as a section. Instead, comment out the content and include comments to explain the situation. For example: + - If a section within the template is not needed, comment out the section title and label reference. Do not delete the expected section title, reference or related comments provided from the template. + - If a file cannot include a title (surrounded by ampersands (#)), comment out the title from the template and include a comment explaining why this is implemented (in addition to applying the ``title`` directive). + +.. This is the label that can be used for cross referencing this file. +.. Recommended title label format is "Directory Name"-"Title Name" -- Spaces should be replaced by hyphens. +.. _DP0-Delegate-Resources-DP0-Assemblies-Schedule: +.. Each section should include a label for cross referencing to a given area. +.. Recommended format for all labels is "Title Name"-"Section Name" -- Spaces should be replaced by hyphens. +.. To reference a label that isn't associated with an reST object such as a title or figure, you must include the link and explicit title using the syntax :ref:`link text `. +.. A warning will alert you of identical labels during the linkcheck process. + +.. This file does not contain a title because it is a table for another location (dp0-delegate-resources/index.rst). +.. title:: DP0 Delegate Assemblies Schedule +.. ################################ +.. DP0 Delegate Assemblies Schedule +.. ################################ + +.. This section should provide a brief, top-level description of the page. + +.. Use *italics* for tentative topics. + +.. Use double-underscore for external links to prevent duplicate explicit target names. + +.. list-table:: Schedule and planned content of DP0 Delegate Assemblies + :header-rows: 1 + :widths: 1 2 2 + + * - Date + - First Hour + - Second Hour + * - 2023-08-18 + - `DP0.3 Kick-Off Info Session `_ (Melissa Graham) + - *general Q&A, breakouts* + * - 2023-09-01 + - `DP0.3 Portal tutorials 01 and 02 `_ (Greg Madejski) + - *general Q&A, breakouts* + * - 2023-09-15 + - `DP0.3 Notebook tutorial 02: Main Belt Asteroids `_ (Jeff Carlin) + - *general Q&A, breakouts* + * - 2023-09-29 + - `DP0.3 Simulation Overview: Populations, Easter Eggs, Etc. `_ (Pedro Bernardinelli, Jake Kurlander) + - no breakouts this week + * - 2023-10-13 + - `DP0.3 Notebook tutorial 03: Trans-Neptunian Objects `_ (Andrés A. Plazas Malagón, Sarah Greenstreet) + - *general Q&A, breakouts* + * - **2023-10-20** + - **Special Assembly:** `SSSC Mini-Sprint Preparation (Meg Schwamb) `_ + - *general Q&A, breakouts* + * - 2023-10-27 + - `DP0.3 Notebook tutorial 04a/b: Introduction to phase curves and advanced phase curve modeling (Yumi Choi, Christina Williams) `_ + - *general Q&A, breakouts* + * - 2023-11-10 + - `Accessibility Hackathon for Notebooks `_ (Jenn Kotler, Andrés A. Plazas Malagón) + - *breakouts: bring your own notebook, add accessibility features!* + * - 2023-12-08 + - `Using TOPCAT with the DP0.2 TAP Service (Introduction to the RSP API Aspect and DP0.2 API TOPCAT tutorial 01) `_ (Douglas Tucker) + - *general Q&A, breakouts* + + +Additional delegate assemblies to be posted. +Rows in *italics* are tentative topics. + + diff --git a/docs/delegate-resources/index.rst b/docs/delegate-resources/index.rst new file mode 100644 index 0000000..19fffea --- /dev/null +++ b/docs/delegate-resources/index.rst @@ -0,0 +1,466 @@ +###################### +DP0 delegate resources +###################### + +.. Review the README on instructions to contribute. +.. Review the style guide to keep a consistent approach to the documentation. +.. Static objects, such as figures, should be stored in the _static directory. Review the _static/README on instructions to contribute. +.. Do not remove the comments that describe each section. They are included to provide guidance to contributors. +.. Do not remove other content provided in the templates, such as a section. Instead, comment out the content and include comments to explain the situation. For example: + - If a section within the template is not needed, comment out the section title and label reference. Do not delete the expected section title, reference or related comments provided from the template. + - If a file cannot include a title (surrounded by ampersands (#)), comment out the title from the template and include a comment explaining why this is implemented (in addition to applying the ``title`` directive). + +.. This is the label that can be used for cross referencing this file. +.. Recommended title label format is "Directory Name"-"Title Name" -- Spaces should be replaced by hyphens. +.. _DP0-Delegate-Resources-DP0-Delegate-Homepage: +.. Each section should include a label for cross referencing to a given area. +.. Recommended format for all labels is "Title Name"-"Section Name" -- Spaces should be replaced by hyphens. +.. To reference a label that isn't associated with an reST object such as a title or figure, you must include the link and explicit title using the syntax :ref:`link text `. +.. A warning will alert you of identical labels during the linkcheck process. + +.. This section should provide a brief, top-level description of the page. + +This page includes the guidelines, resources, and activities for DP0 delegates using the DP0.2 and/or DP0.3 data sets. + +"**DP0 delegates**" are the scientists and students who have accounts in the Rubin Science Platform (RSP) +at the Interim Data Facility (IDF; the Google Cloud) during Data Preview 0 (DP0). + +The term "delegate" has been adopted for DP0 to reflect participants’ important roles of representing the broad science community +as learners, testers, and providers of feedback, and of sharing the benefits of their DP0 participation with their +communities as teachers and colleagues. +Delegates’ DP0-related activities are supported with resources and infrastructure as described on this page. + +The number of delegates is currently limited to 900, but space is available. + +.. _Delegate-Homepage-Getting-Started-Checklist: + +Getting started with DP0 checklist +================================== + +Becoming a delegate and accessing the DP0 data is as easy as following this checklist and getting an account in the Rubin Science Platform (RSP). + +There is no application process. +The only prerequisite is to be a Rubin data rights holder. +Although the number of delegates is currently limited to 900, there is space available and all petitions are being accepted. +If that changes this page will be updated. + +Mandatory steps to becoming a delegate: + +1. Review the :ref:`Delegate-Homepage-Guidelines-Expectations`. +2. Submit a petition for one of the :ref:`Delegate-Homepage-RSP-Accounts`. +3. Set up your account in the :ref:`Delegate-Homepage-Forum`. +4. Watch the recorded DP0.2 :ref:`Delegate-Homepage-Kickoff` (13 minutes). +5. Review your options for :ref:`Delegate-Homepage-Getting-Support`. + +Optional (but recommended) steps for delegates: + +.. TODO re-add links to the RSP intros + +6. Work at your own pace through the `DP0.2 Tutorials `__ or `DP0.3 Tutorials `_. +7. Review the data products definitions documentation for `DP0.2 `_ and/or `DP0.3 `_. +8. Follow step-by-step introductions to the RSP's Portal or Notebook aspects. +9. Attend :ref:`Delegate-Homepage-DP0-Virtual-Seminars` or watch recordings where available. +10. Consider the :ref:`Delegate-Homepage-Delegate-Activities`. +11. Be aware that the `Rubin Users Committee `_ are your advocates. + + +.. _Delegate-Homepage-Guidelines-Expectations: + +Guidelines and expectations +=========================== + +**Rubin data rights** are required to hold an account in the Rubin Science Platform. + +**Who has Rubin data rights?** +All scientists and students affiliated with an institution in the US and Chile have data rights, +as well as the international scientists and students whose names appear on the +`list of international data rights holders `_. +For more information about data rights, please refer to the +`Rubin Observatory Data Policy `_. +If you're not sure if you have data rights, contact Melissa Graham at mlg3k@uw.edu or +with a direct message in the `Rubin Community Forum `_. + +.. TODO re-add + +.. **Understand the** :doc:`/data-access-analysis-tools/rsp-warnings` **regarding using the DP0-era RSP**. + +**Abide by the** :ref:`Delegate-Homepage-Code-of-Conduct`. + +**Adhere to the** :ref:`Delegate-Homepage-PubPol`. + +.. _Delegate-Homepage-RSP-Accounts: + +Rubin Science Platform accounts +=============================== + +**Petition for your RSP account:** +Follow the instructions on `how to get an RSP account `_ +to submit a petition. +Using your full professional name and your institutional email address will facilitate the process. +It might take a few days for your Rubin data rights to be verified and your petition accepted. + +**Petition approved? You are now a DP0 delegate!** +Once your petition is approved and you can log in to `data.lsst.cloud `_, you are a DP0 delegate. +Welcome! +Please continue to read the information below and complete the checklist above. + +**Problems with the petition?** +Please contact Melissa Graham at mlg3k@uw.edu or Heather Shaughnessy at sheather@slac.stanford.edu, +or post a new Topic requesting assistance in the `Support - Data Preview 0 `_ +category of the `Rubin Community Forum `_, +or submit a `GitHub issue in the rubin-dp0 Support repo `_. + +**Log in:** +Navigate to `data.lsst.cloud `_ and choose "Log in" at upper-right, +or choose to enter either the Portal or Notebook Aspect. +In most cases, the authorization will be done via your institutional login. + +.. TODO re-add link to rsp-warnings + +**Policies:** +RSP accounts are not transferable and delegates must not share their password with others. +DP0 delegates are being given access to a *shared-risk developmental version* of the RSP and the accompanying documentation. + +.. **Everyone is responsible for their own safe usage of the RSP** and must be familiar with this list of :doc:`/data-access-analysis-tools/rsp-warnings`. + +**Deactivating or canceling accounts:** +Please contact Melissa Graham at mlg3k@uw.edu or +with a direct message in the `Rubin Community Forum `_ +for instructions on how to delete your RSP account. + + +.. _Delegate-Homepage-Forum: + +Rubin Community Forum +===================== + +The `Rubin Community Forum `__ is the central hub for all news, discussions, and support related to DP0. + +**Accounts:** +Go to `community.lsst.org `_ and use the "Sign Up" button at upper-right to create an account. + +**Join the "DP0 Delegates" group to stay informed:** +Go to `community.lsst.org/groups `_ and join "DP0 Delegates". +DP0-related news and events are shared as direct messages via the forum to this group (not via email). +To receive email notifications, set your Community Forum user profile preference for "Email me when I am sent a personal message" to "Always". +Joining this group also ensures that you have access to the "Support - DP0 RSP Service Issues" subcategory. + +**Find DP0-related content in the Forum:** +The `Support - Data Preview 0 `_ category is for any and all questions and discussions related to DP0. +E.g., how to use the RSP's aspects for science; the contents of the DC2 data set; delegate activities; sharing DP0-related notebooks, plots, or results. +The "Support - DP0 RSP Service Issues" is a private subcategory for technical Q&A and discussion about potential bugs, service outages, etc. +It is also possible to view a list of all `topics tagged with #dp0 `_ across all categories. + +Participating in the Rubin Community Forum is an integral part of the :ref:`Delegate-Homepage-Delegate-Activities`, +such as sharing DP0-related results with Rubin staff and other delegates, +and also of :ref:`Delegate-Homepage-Getting-Support` for DP0-related activities. + +**For new Forum members:** +People new to the Rubin Community Forum might appreciate `this video demonstrating how to navigate and post topics to the forum `_. + + + +.. _Delegate-Homepage-Kickoff: + +Kick-off info session +===================== + +All **new** delegates must review the recording if they did not attend a live session. +This session occurred at the time of the release of DP0.2, but remains relevant for delegates +who are only interested in DP0.3. + +`View the recorded presentation and slide deck. `__ + +The session covered: DP0 goals and the road to Rubin Observatory operations; +RSP and Community Forum accounts; introductory demo to the Portal and Notebook aspects; +RSP hazards and delegate expectations; and resources and support for delegates. + + +.. _Delegate-Homepage-DP0-Virtual-Seminars: + +DP0 virtual seminars +==================== + +Attendance at any of the following virtual seminars is optional for DP0 delegates. + + +.. _Delegate-Homepage-DP0-Virtual-Summer-School-2023: + +DP0 virtual summer school 2023 +------------------------------ + +Held June 12-16, 2023. + +.. toctree:: + :maxdepth: 1 + :glob: + + virtual-summer-school-2023 + + + +.. _Delegate-Homepage-DP0-Delegate-Assemblies: + +DP0 Delegate Assemblies +----------------------- + +**Connection Info:** `ls.st/dp0-events `_ + +**Dates and times:** *TBD; Delegate Assemblies are on a temporary hiatus through Feb 2024.* +(For exact dates, see table below. +Generally held biweekly on Fridays from 9am to 11am US Pacific, alternating with :ref:`DP0-Delegate-Programming-StackClub`.) + +The Delegate Assemblies are live, virtual seminars for DP0 delegates to learn more about DP0, the RSP, and the DC2 data set. +Attendance is optional and all are welcome. + +Typically, the first hour contains a presentation or hands-on tutorial, and the second hour is spent in breakout rooms for +discussion or co-working on topics suggested by delegates. + +Rubin Observatory staff are always available in the main room to answer questions and provide assistance with DP0-related work during breakouts. + +Contributed presentations, tutorials, or advance suggestions for breakouts are encouraged from DP0 delegates and Rubin Observatory staff (contact Melissa Graham). + +You can view :doc:`topics and recordings for Delegate Assemblies from July 2022 to July 2023 `, +all of which were based on the DP0.2 data set. + +.. include:: dp0-delegate-assemblies-schedule.inc + +.. toctree:: + :hidden: + + assembly-recordings + + +.. _DP0-Delegate-Programming-StackClub: + +Stack Club +---------- + +**Connection Info:** `ls.st/dp0-events `_ + +**Dates and times:** *TBD; Stack Club is on a temporary hiatus through Feb 2024.* +(Generally alternates with :ref:`Delegate-Homepage-DP0-Delegate-Assemblies`.) + +`Stack Club `_ is an open, drop-in session for working with the DP0 data sets and/or the +Rubin Observatory `LSST Science Pipelines`_ (colloquially called "the Stack"). +Stack Club sessions begin with a roundtable discussion of what people want to do or learn or get assistance with that day. +Then some people either go into breakout rooms to co-work and discuss, or work individually while staying connected +to the main room where they can ask questions if and when they arise. +Rubin Observatory staff are always present to provide support for DP0 and the RSP, or more generally for +preparations for LSST science (e.g., grant proposals, grad/undergrad courses). +Everyone is welcome to attend for the full two hours, or join for a few minutes and ask a question (like an office hour). + +.. TODO re-add link +.. The original impetus for Stack Club's formation was, in part, to create "tutorials for users by users". +.. Stack Club is a great place to work on :ref:`DP0-2-Tutorials-Contributed`, either individually or in collaboration with others. + + +.. _DP0-Delegate-Programming-ThirdThursday: + +Third Thursday office hour +-------------------------- + +**Dates and times:** *TBD; Third Thursdays are on a temporary hiatus through Feb 2024.* + +In the past, they were held on the third Thursday of every month at 04:00 and 14:00 UTC. +These two time slots serve the Asia-Pacific (APAC) and Europe, the Middle East, and Africa (EMEA) time zones, respectively. +Note that in the western Americas (AMER) time zone, the first slot at 04:00 UTC is actually on Wednesday evening. + +These office hour sessions are open, drop-in discussions designed to compensate for the fact that the time of the Delegate Assemblies was only convenient for DP0 delegates in North and South America, Europe, and Africa. +Everyone is welcome to attend any of these sessions, instead of or in addition to the Delegate Assemblies and the Stack Club sessions. + +There is no set agenda for these sessions, but Rubin Observatory staff are always in attendance, and topics are left open to attendees. +For example, delegates could discuss their DP0-related analysis with Rubin Observatory staff and with each other, review the DP0 RSP tutorials together, +collaborate on DP0-related science, and get support from Rubin Observatory staff as needed. + +Please see `this Rubin Community Forum topic `__ for more information about the Third Thursdays. + + +.. _DP0-Delegate-Programming-CustomSeminars: + +Custom virtual or in person seminars +------------------------------------ + +In addition to the virtual seminars and the publicly available recordings, additional requests for custom hands-on activities +(virtual or in person) can be considered. +Due to the limited resources, priority will be given to requests from scientists at small and/or underserved institutions (SUIs). +Requests sent at least 6 weeks in advance are more likely to be accommodated. + +**Example requests:** + +* Group "onboarding" (account set ups, learning about Rubin in general, learning about specific resources) for, e.g., students at PUIs. +* Invitations to provide virtual or in person tutorials related to DP0 at, e.g., a workshop. + +To broaden the participation of the Rubin community in the activity, one or both of the following should be adopted. + +* The request should have a specific plan to include scientists and/or students at SUIs. For example, the activity could take place at a SUI or include funding access to the activity for scientists from SUIs. +* The main activity (not including Q&A), should be recorded and made publicly available to be linked on this page. Alternatively, the recording can be shared to be posted by the Community Science Team. + +Contact method: Contact Melissa Graham (mlg3k@uw.edu) or send a direct message to the +`Community Science Team `_ via the Rubin Community Forum. + +.. _Delegate-Homepage-Delegate-Activities: + +Suggested delegate activities +============================= + +**Learn to use the Rubin Science Platform.** +All delegates are encouraged to use the documentation, instructions, and tutorials to learn how to use the RSP, and its various tools for accessing and analyzing LSST data. + +.. TODO re-add links + +.. For example, read and follow the step-by-step introductions on how to use the the RSP's :ref:`Tools-RSP-Portal` or :ref:`Tools-RSP-Notebook`. +.. Then, work through the :doc:`/tutorials-examples/index`. +.. Both the Portal and Notebook tutorials are numbered in order of increasing difficulty. + +**Prepare to do science with the Data Previews.** +In the coming years, *real commissioning data* will be released as Data Preview 1 (DP1) and DP2, +as described in the `plans for early science with Rubin Observatory `_. + +For example, use the simulated LSST-like data set of DP0 to generate and test your custom analysis software now, +so that you're more prepared for early science with future data previews. + +Beyond these two main activities, all delegates are invited to take on additional activities that will **inform and improve RSP development**, +and/or **extend and enhance the benefits of DP0** within the science community beyond the limited number +of DP0 participants that Rubin Observatory is able to support. + +Inform and improve the RSP +-------------------------- + +**Participate in feedback surveys.** +When requested, complete the DP0 delegate feedback surveys for Rubin Observatory. +Read about `the results from the first DP0 survey `__. + +**Submit bug reports.** +Help with RSP improvements by submitting bug reports via `GitHub issues `_ (see :ref:`Delegate-Homepage-Getting-Support`). + +**Suggest new features.** +Help with RSP development by suggesting new RSP features via `GitHub issues `_, or by communicating directly with the Rubin `Users Committee `_ to advocate for the tools that you need for your LSST science goals. + +**Share your experiences with Rubin Observatory staff.** +Post about your DP0 investigations in the `Data Preview 0 Community Forum category `_, so Rubin Observatory staff can see how users are doing science with the RSP. + +Extend the benefits of DP0 in the science community +--------------------------------------------------- + +**Join an LSST Science Collaboration.** +There are eight `LSST Science Collaborations `_, and new members are always welcome. + +**Participate in the Rubin Community Forum.** +Ask questions about DP0, or show-and-tell your DP0-related investigations in the `Data Preview 0 Community Forum category `_. +Respond to questions or discussion topics raised by other DP0 delegates. +This helps to build a global self-supporting network of scientists engaged in LSST research. + +**Participate in the DP0 virtual seminars.** +Attend the :ref:`Delegate-Homepage-DP0-Virtual-Seminars` sessions: Delegate Assemblies, Stack Club, or Third Thursday. +Ask questions and join the breakout discussions. +All are welcome to volunteer to facilitate a breakout room or to give a presentation (contact Melissa Graham). + +**Contribute tutorial notebooks.** +All delegates are welcome to share their own Jupyter Notebooks using the `delegates' shared repo `_. +Step-by-step tutorials that use the Portal, API, or command-line are also welcome. + +**Share your DP0-related work outside of DP0.** +For example, give a seminar about Rubin Observatory and DP0 at your home institution, give a tutorial about your RSP/DP0 experience in your Science Collaboration, or publish a paper on your DP0-related work. +Be sure to refer to the :ref:`Delegate-Homepage-PubPol`. + + +.. _Delegate-Homepage-Getting-Support: + +Getting support +=============== + +Several venues are provided to support DP0 delegates, as described below. +There is no wrong place to post questions or requests for assistance! +Hearing about issues and receiving feedback from delegates is a key component of DP0 for Rubin Observatory staff. + +Scientific support via the Community Forum +------------------------------------------ + +The `Data Preview 0 Community Forum category `_ is the best place for DP0 delegates +to post topics related to scientific support. + +Scientific support includes questions about the DC2 simulated data set, the DP0 data products, and/or the application of the +LSST Science Pipelines to the DP0 data set, as well as general discussion about DP0-related scientific analyses, or DP0 policies and guidelines. + +This subcategory is monitored by the Rubin Observatory `Community Science team (CST) `_. +DP0 delegates are especially encouraged to post new topics and reply to others' posts in this subcategory. + +Technical assistance via GitHub issues +-------------------------------------- + +Bug reports, persistent technical issues, and requests for assistance from Rubin Observatory staff can be submitted by DP0 delegates +as GitHub issues in the `rubin-dp0 GitHub Organization's Support repository `_. +Requests for new features or for global installations of commonly used software packages are also welcome via GitHub issues. + +In the horizontal menu bar at the top of that page, click on the “Issues” option (with the circled dot icon), +then choose the green “New Issue” button at right. +Next to either “Bug report” or "Feature request" choose “Get started” (as appropriate for your case), and fill in the title and contents of your issue. +In the right side-menu, do adjust the labels as appropriate, but leave the other options. +Click “Submit new issue” when you’re ready. +These issues will be addressed by Rubin Observatory staff. + +Minor or ambiguous RSP service and access issues +------------------------------------------------ + +Please feel free to post even small questions as new topics in the "Support - DP0 RSP Service Issues" private subcategory of the Community Forum. + +This subcategory enables DP0 delegates to determine if others are experiencing the same issue (e.g., *"is this local or general network outage?"*, *"my query is taking a long time, is this a real problem or did I do it wrong?"*), +crowd-source solutions to technical issues from each other when possible, and have a non-public venue for DP0-related questions. +Updates about commonly experienced access issues or planned service outages will be posted by Rubin Observatory staff in this category. + +Since the "DP0 RSP Service Issues" subcategory is not public, it cannot be linked to directly, but anyone who is logged in to the Community Forum can access it via the main landing page at `community.lsst.org `_. + +Read more in the Community Forum about `Scientific Support and Technical Assistance for DP0 Delegates `_. + +Live support during virtual seminars +------------------------------------ + +Bring your questions to the :ref:`Delegate-Homepage-DP0-Virtual-Seminars` sessions: Delegate Assemblies, Stack Club, or Third Thursday. +Rubin Observatory staff members will usually be in attendance and able to assist you. + + +.. _Delegate-Homepage-Code-of-Conduct: + +Code of conduct +=============== + +Please review the Rubin Code of Conduct (CoC) at `ls.st/comms-coc `_. + +| To summarize the CoC: +| - Bullying and harassment will not be tolerated. +| - Research inclusion and collaborative work must not be impeded by poor behavior. +| - Discussion should be constructive and civil at all times. + +If you experience or witness a violation of the CoC in the Community Forum, please `flag the post `_. +Forum moderators will handle the issue from there. +Please note that there are a few reasons why posts get flagged, and CoC violations are only one of them. +Here are some guidelines on `how to react if your post is flagged `_. + +If you experience or witness a violation of the CoC in another venue, please reach out to Sandrine Thomas, one of the `Rubin Observatory Workplace Culture Advocates `_ who has agreed to be the contact person for DP0 Delegates. + + +.. _Delegate-Homepage-PubPol: + +Citation policies +================= + +**Cite the DESC’s publications for the DC2 simulated data set**, which is being used for DP0.1 and DP0.2. +If you publish work based on the DP0.1 or DP0.2 data set, you must cite “CosmoDC2: A Synthetic Sky Catalog for Dark Energy Science with LSST” +(`Korytov et al 2019 `_), “The LSST DESC DC2 Simulated Sky Survey” (`arXiv:2010.05926 `_), +and potentially “DESC DC2 Data Release Note” (`arXiv:2101.04855 `_) if you used the Object or Truth-Match tables, which are presented in that release note. + +**Consider extending co-authorship or acknowledgments to DP0 delegates whose work you used, or who have helped you, as appropriate.** +Delegates are encouraged to openly share their DP0-related work and/or code during :ref:`Delegate-Homepage-DP0-Delegate-Assemblies`, via the `Community Forum `_, and in the shared GitHub repository `delegate-contributions-dp02 `_. +This is intended to facilitate collaboration, which requires proper acknowledgments. +For example, if you use another delegate’s Jupyter Notebook as a starting point for your Notebook, give credit to that person at the top of your Notebook. +If another delegate’s work contributed to your DP0-related publication, consider including an acknowledgment, citing their relevant publications, and/or extending co-authorship, as appropriate. + +**Be aware that DP0-related work done by Science Collaboration (SC) members might be subject to the publication policies of their Science Collaborations.** +Significant overlap between the DP0 working groups and SC working groups, committees, or task forces is to be expected, because the science goals of DP0 and the SCs overlap (i.e., preparing for LSST). +Each SC has their own policies regarding collaboration, co-authorship, and publications and delegates are responsible for following the policies of their SCs, if and when they pertain to their DP0-related work. +If cases of real or perceived conflict between the general open nature of DP0 collaboration and any SC policies arise, delegates are expected to understand and abide by their SC’s policies. +In other words, the fact that work is DP0-related does not nullify any SC policies that might apply to a delegate’s work. +Example scenarios might include sharing SC-developed software with delegates who are not members of that SC, or using code or analysis results collaboratively by delegates in a SC publication. + +Note that the `Rubin Observatory Publication Policy `_ does not apply to publications by delegates that are based on their DP0 work. diff --git a/docs/delegate-resources/virtual-summer-school-2023.rst b/docs/delegate-resources/virtual-summer-school-2023.rst new file mode 100644 index 0000000..5c04644 --- /dev/null +++ b/docs/delegate-resources/virtual-summer-school-2023.rst @@ -0,0 +1,149 @@ +.. Review the README on instructions to contribute. +.. Review the style guide to keep a consistent approach to the documentation. +.. Static objects, such as figures, should be stored in the _static directory. Review the _static/README on instructions to contribute. +.. Do not remove the comments that describe each section. They are included to provide guidance to contributors. +.. Do not remove other content provided in the templates, such as a section. Instead, comment out the content and include comments to explain the situation. For example: + - If a section within the template is not needed, comment out the section title and label reference. Do not delete the expected section title, reference or related comments provided from the template. + - If a file cannot include a title (surrounded by ampersands (#)), comment out the title from the template and include a comment explaining why this is implemented (in addition to applying the ``title`` directive). + +.. This is the label that can be used for cross referencing this file. +.. Recommended title label format is "Directory Name"-"Title Name" -- Spaces should be replaced by hyphens. +.. _DP0-Delegate-Resources-VSS2023: +.. Each section should include a label for cross referencing to a given area. +.. Recommended format for all labels is "Title Name"-"Section Name" -- Spaces should be replaced by hyphens. +.. To reference a label that isn't associated with an reST object such as a title or figure, you must include the link and explicit title using the syntax :ref:`link text `. +.. A warning will alert you of identical labels during the linkcheck process. + +############################## +DP0 Virtual Summer School 2023 +############################## + +.. This section should provide a brief, top-level description of the page. + +.. _DP0-Delegate-Resources-VSS2023-update: + +Post-summer school update +========================= + +**Update, June 23, 2023:** This meeting has already taken place. See :ref:`below ` for links to video recordings of all sessions. + +---- + +**Dates**: June 12-16, 2023 + +**Times** (delegates may attend either session): + +Session A: 8:00-11:00 PDT (15:00-18:00 UTC) + +Session B: 19:00-21:00 PDT (02:00-04:00 UTC; +1 day) + +**Location**: virtual + +**Eligibility**: All DP0 delegates are eligible to register for the DP0 Virtual Summer School. +There is currently space available for new DP0 delegates: +for more information about how to become a delegate, see the :ref:`Delegate-Homepage-Getting-Started-Checklist`. + + +.. _DP0-Delegate-Resources-VSS2023-overview: + +Overview +======== + +**What is DP0?** +Data Preview 0.2 (`DP0.2 `_), which was released on June 30, 2022, is based on simulated +Legacy Survey of Space and Time (LSST)-like images that were generated by the Dark Energy Science Collaboration (DESC), +and then processed with the LSST Science Pipelines to provide data products in the same format as future (real) data releases. +These data products can be accessed and analyzed via the web-based Rubin Science Platform +(`RSP `_). + +**Goals.** +The goal of this DP0 Virtual Summer School is to introduce any data-rights holding scientist +(from undergraduate student to faculty/staff) to the `DP0.2 dataset `_ +and the RSP and to provide an accelerated learning experience enabling research on Rubin data with a focus on the DP0.2 dataset. +In order to develop a thriving Rubin science community, another key goal of the Virtual Summer School is to provide opportunities +for networking, collaboration, and new-skill acquisition for participants. + +**Schedule.** +The Virtual Summer School will span 5 days between June 12 - 16, where each day will be split into two 2-3 hr sessions to +accommodate the international time-zones of the participants. +The curriculum will cover key utilities of the RSP (e.g., Catalogs, Images, TAP, Butler) with guided tutorials by members of the +Rubin Community Engagement Team, and there will be dedicated time for collaborative discussions and hack sessions. +The primary meeting platform will be Zoom. + + + +.. _DP0-Delegate-Resources-VSS2023-Registration: + +Registration Form +================= + +Registration is closed, as the Summer School has already taken place. + + +.. _DP0-Delegate-Resources-VSS2023-SOC: + +Science Organizing Committee +============================ + +**CST Members:** Jeff Carlin, Gloria Fonseca Alvarez, Melissa Graham, Ryan Lau, Douglas Tucker + +**Delegate Members:** Louise Edwards, Nandini Hazra, Vincenzo Petrecca, Fabio Ragosta + + + +.. _DP0-Delegate-Resources-VSS2023-Agenda: + +Agenda +====== + +.. raw:: html + + + +Download the agenda as a pdf file: :download:`agenda `. + +Download the agenda as a txt file: :download:`agenda `. + +Note that all times are given in the PDT (Pacific Daylight Time) time zone. For conversion to your local time, try `this time zone converter `__ (use Los Angeles as the anchor for PDT). + +.. _DP0-Delegate-Resources-VSS2023-Videos: + +Videos +====== + +For information about the topics covered in each of these sessions, see the :ref:`agenda ` in the section above this one. + +`Monday, June 12, Session A `__ + +`Monday, June 12, Session B `__ + +`Tuesday, June 13, Session A `__ + +`Tuesday, June 13, Session B `__ + +`Wednesday, June 14, Session A `__ + +`Wednesday, June 14, Session B `__ + +`Thursday, June 15, Session A `__ + +`Thursday, June 15, Session B `__ + +`Friday, June 16, Session A `__ + + +Accessibility +============= + +The CST will make this virtual workshop as accessible as we can for those attending. If there are any accommodations that would facilitate your participation, the registration form will include an anonymous request form. + +The workshop will include automated captions, written instructions, and breaks. +All tutorials will be available beforehand and the website will include accessibility-related information. + + +.. _DP0-Delegate-Resources-VSS2023-Contact: + +Contact +======= + +If you have any questions please contact Melissa Graham via direct message in the Rubin `Community Forum `_ (preferred) or via email mlg3k AT uw DOT edu. diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..ab73c3b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,28 @@ +:html_theme.sidebar_secondary.remove: + +################################# +LSST Data Preview 0 Documentation +################################# + +Data Preview 0 (DP0) is the first of three data previews during the period leading up to the start of Rubin Observatory Operations. +The goals of DP0 are to serve as an early integration test of the Legacy Survey of Space and Time (LSST) Science Pipelines and the Rubin Science Platform (RSP), and to enable a limited number of astronomers and students to begin early preparations for science with the LSST. + +.. toctree:: + :hidden: + + Delegate resources + +.. grid:: 3 + + .. grid-item-card:: DP0 delegate resources + :link: delegate-resources/index + :link-type: doc + + *DP0 delegates* are the scientists and students who have accounts in the Rubin Science Platform (RSP) at the Interim Data Facility (IDF; the Google Cloud) during Data Preview 0 (DP0). + + +Related documentation +===================== + +- `Rubin Science Platform`_ — Learn how to use the Rubin Science Platform to access and analyze LSST data. +- `LSST Science Pipelines`_ — Learn about the Rubin LSST's Python data processing, measurement, and access software, which you can use from the Rubin Science Platform. diff --git a/documenteer.toml b/documenteer.toml new file mode 100644 index 0000000..ef6c010 --- /dev/null +++ b/documenteer.toml @@ -0,0 +1,18 @@ +[project] +title = "DP0" +copyright = "2024 Association of Universities for Research in Astronomy, Inc. (AURA)" +base_url = "https://dp0.lsst.io" +github_url = "https://github.com/lsst/dp0_lsst_io" +version = "Current" + +[sphinx] +extensions = [] +rst_epilog_file = "rst_epilog.rst" + +[sphinx.intersphinx.projects] +python = "https://docs.python.org/3/" +rsp = "https://rsp.lsst.io/" +pipelines = "https://pipelines.lsst.io/" + +[sphinx.linkcheck] +ignore = [] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f15aec8 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +documenteer[guide]>1.0,<2.0 diff --git a/rst_epilog.rst b/rst_epilog.rst new file mode 100644 index 0000000..3eb1cad --- /dev/null +++ b/rst_epilog.rst @@ -0,0 +1,4 @@ +.. These are links and substitutions available to any rst page + +.. _`Rubin Science Platform`: https://rsp.lsst.io +.. _`LSST Science Pipelines`: https://pipelines.lsst.io diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..6ec469b --- /dev/null +++ b/tox.ini @@ -0,0 +1,24 @@ +[tox] +envlist = + html, linkcheck, lint +isolated_build = True + +[testenv] +basepython = python +deps = + -rrequirements.txt + +[testenv:html] +commands = + sphinx-build -b html -d _build/doctree -n -W -c . docs _build/html + +[testenv:linkcheck] +commands = + sphinx-build -b linkcheck -d _build/doctree -n -W -c . docs _build/linkcheck + +[testenv:lint] +description = Lint code and configurations by running pre-commit. +skip_install = true +deps = + pre-commit +commands = pre-commit run --all-files