Initial commit

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yaml

@@ -0,0 +1,12 @@
+name: CI
+
+'on': [push, pull_request, workflow_dispatch]
+
+jobs:
+  call-workflow:
+    uses: lsst-sqre/rubin-sphinx-technote-workflows/.github/workflows/ci.yaml@v1
+    with:
+      handle: dmtn-294
+    secrets:
+      ltd_username: ${{ secrets.LTD_USERNAME }}
+      ltd_password: ${{ secrets.LTD_PASSWORD }}

.gitignore

@@ -0,0 +1,5 @@
+_build/
+.technote/
+.tox/
+venv/
+.venv/

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      # - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-toml

COPYRIGHT

@@ -0,0 +1 @@
+Copyright 2024 The Trustees of Princeton University

Makefile

@@ -0,0 +1,26 @@
+.PHONY:
+init:
+	pip install tox pre-commit
+	pre-commit install
+
+.PHONY:
+html:
+	tox run -e html
+
+.PHONY:
+lint:
+	tox run -e lint,linkcheck
+
+.PHONY:
+add-author:
+	tox run -e add-author
+
+.PHONY:
+sync-authors:
+	tox run -e sync-authors
+
+.PHONY:
+clean:
+	rm -rf _build
+	rm -rf .technote
+	rm -rf .tox

README.rst

@@ -0,0 +1,51 @@
+.. image:: https://img.shields.io/badge/dmtn--294-lsst.io-brightgreen.svg
+   :target: https://dmtn-294.lsst.io
+.. image:: https://github.com/lsst-dm/dmtn-294/workflows/CI/badge.svg
+   :target: https://github.com/lsst-dm/dmtn-294/actions/
+
+##############################################
+File Formats and Layouts for Cell-based Coadds
+##############################################
+
+DMTN-294
+========
+
+Rubin's deep coadds will be built in on a grid of small cells, in which each cell has an approximately constant PSF.  Cells will have "inner regions" that can be stitched together to form the full coadd, but they will also have outer regions that overlap (neighboring cells will have their own versions of some of the same pixels), in order to allow convolutions and other operations that require padding to be performed rigorously cell by cell.  This creates a problem for how to store a coadd in an on-disk FITS file: we want a layout that can be easily interpreted by third-party readers, but we also need to support compression and efficient subimage reads of at least the inner cell region.  This technical note will summarize various possibilities and their advantages and disadvantages.
+
+**Links:**
+
+- Publication URL: https://dmtn-294.lsst.io
+- Alternative editions: https://dmtn-294.lsst.io/v
+- GitHub repository: https://github.com/lsst-dm/dmtn-294
+- Build system: https://github.com/lsst-dm/dmtn-294/actions/
+
+
+Build this technical note
+=========================
+
+You can clone this repository and build the technote locally if your system has Python 3.11 or later:
+
+.. code-block:: bash
+
+   git clone https://github.com/lsst-dm/dmtn-294
+   cd dmtn-294
+   make init
+   make html
+
+Repeat the ``make html`` command to rebuild the technote after making changes.
+If you need to delete any intermediate files for a clean build, run ``make clean``.
+
+The built technote is located at ``_build/html/index.html``.
+
+Publishing changes to the web
+=============================
+
+This technote is published to https://dmtn-294.lsst.io whenever you push changes to the ``main`` branch on GitHub.
+When you push changes to a another branch, a preview of the technote is published to https://dmtn-294.lsst.io/v.
+
+Editing this technical note
+===========================
+
+The main content of this technote is in ``index.rst`` (a reStructuredText file).
+Metadata and configuration is in the ``technote.toml`` file.
+For guidance on creating content and information about specifying metadata and configuration, see the Documenteer documentation: https://documenteer.lsst.io/technotes.

conf.py

@@ -0,0 +1,4 @@
+# See the Documenteer docs for how to customize conf.py:
+# https://documenteer.lsst.io/technotes/
+
+from documenteer.conf.technote import *  # noqa F401 F403

index.rst

@@ -0,0 +1,12 @@
+##############################################
+File Formats and Layouts for Cell-based Coadds
+##############################################
+
+.. abstract::
+
+   Rubin's deep coadds will be built in on a grid of small cells, in which each cell has an approximately constant PSF.  Cells will have "inner regions" that can be stitched together to form the full coadd, but they will also have outer regions that overlap (neighboring cells will have their own versions of some of the same pixels), in order to allow convolutions and other operations that require padding to be performed rigorously cell by cell.  This creates a problem for how to store a coadd in an on-disk FITS file: we want a layout that can be easily interpreted by third-party readers, but we also need to support compression and efficient subimage reads of at least the inner cell region.  This technical note will summarize various possibilities and their advantages and disadvantages.
+
+Add content here
+================
+
+See the `Documenteer documentation <https://documenteer.lsst.io/technotes/index.html>`_ for tips on how to write and configure your new technote.

requirements.txt

@@ -0,0 +1 @@
+documenteer[technote]>=1.0.0a10

technote.toml

@@ -0,0 +1,23 @@
+[technote]
+id = "DMTN-294"
+series_id = "DMTN"
+canonical_url = "https://dmtn-294.lsst.io"
+github_url = "https://github.com/lsst-dm/dmtn-294"
+github_default_branch = "main"
+date_created = 2024-07-22T17:02:08Z
+organization.name = "Vera C. Rubin Observatory"
+organization.ror = "https://ror.org/048g3cy84"
+license.id = "CC-BY-4.0"
+
+[technote.status]
+state = "draft"
+
+[[technote.authors]]
+name.given = "James F."
+name.family = "Bosch"
+internal_id = "boschjf"
+orcid = "https://orcid.org/0000-0003-2759-5764"
+[[technote.authors.affiliations]]
+name = "Department of Astrophysical Sciences"
+internal_id = "Princeton-Astro"
+address = "Princeton University, Princeton, NJ 08544, USA"

tox.ini

@@ -0,0 +1,30 @@
+[tox]
+environments = html
+isolated_build = True
+
+[testenv]
+skip_install = true
+deps =
+    -rrequirements.txt
+
+[testenv:html]
+commands =
+   sphinx-build --keep-going -n -W -T -b html -d _build/doctrees . _build/html
+
+[testenv:linkcheck]
+commands =
+   sphinx-build --keep-going -n -W -T -b linkcheck -d _build/doctrees . _build/linkcheck
+
+[testenv:lint]
+deps = pre-commit
+commands =
+   pre-commit run --all-files
+
+[testenv:add-author]
+commands =
+   documenteer technote add-author
+
+[testenv:sync-authors]
+commands =
+   documenteer technote sync-authors
+