Initial commit

.github/workflows/lint.yaml

@@ -0,0 +1,11 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  call-workflow:
+    uses: lsst/rubin_workflows/.github/workflows/lint.yaml@main

.github/workflows/rebase_checker.yaml

@@ -0,0 +1,8 @@
+---
+name: Check that 'main' is not merged into the development branch
+
+on: pull_request
+
+jobs:
+  call-workflow:
+    uses: lsst/rubin_workflows/.github/workflows/rebase_checker.yaml@main

.gitignore

@@ -0,0 +1,21 @@
+.sconsign.dblite
+config.log
+.sconf_temp
+*.o
+*.os
+*.so
+*.cfgc
+*.pyc
+*_wrap.cc
+*Lib.py
+
+# Built by sconsUtils
+version.py
+bin/
+
+# Pytest
+tests/.tests
+pytest_session.txt
+.cache/
+.pytest_cache
+.coverage

COPYRIGHT

@@ -0,0 +1 @@
+Copyright 2024 University of Washington

README.rst

@@ -0,0 +1,7 @@
+######
+sattle
+######
+
+
+
+.. Add a brief (few sentence) description of what this package provides.

SConstruct

@@ -0,0 +1,3 @@
+# -*- python -*-
+from lsst.sconsUtils import scripts
+scripts.BasicSConstruct("sattle")

bin.src/SConscript

@@ -0,0 +1,3 @@
+# -*- python -*-
+from lsst.sconsUtils import scripts
+scripts.BasicSConscript.shebang()

doc/.gitignore

@@ -0,0 +1,10 @@
+# Doxygen products
+html
+xml
+*.tag
+*.inc
+doxygen.conf
+
+# Sphinx products
+_build
+py-api

doc/SConscript

@@ -0,0 +1,3 @@
+# -*- python -*-
+from lsst.sconsUtils import scripts
+scripts.BasicSConscript.doc()

doc/conf.py

@@ -0,0 +1,14 @@
+"""Sphinx configuration file for an LSST stack package.
+
+This configuration only affects single-package Sphinx documentation builds.
+For more information, see:
+https://developer.lsst.io/stack/building-single-package-docs.html
+"""
+
+from documenteer.conf.pipelinespkg import *
+
+
+project = "sattle"
+html_theme_options["logotext"] = project
+html_title = project
+html_short_title = project

doc/index.rst

@@ -0,0 +1,82 @@
+.. py:currentmodule:: lsst.sattle
+
+.. _lsst.sattle:
+
+###########
+lsst.sattle
+###########
+
+.. Paragraph that describes what this Python module does and links to related modules and frameworks.
+
+.. .. _lsst.sattle-using:
+
+.. Using lsst.sattle
+.. =================
+
+.. toctree linking to topics related to using the module's APIs.
+
+.. .. toctree::
+..    :maxdepth: 1
+
+.. _lsst.sattle-contributing:
+
+Contributing
+============
+
+``lsst.sattle`` is developed at https://github.com/lsst-dm/sattle.
+You can find Jira issues for this module under the `sattle <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20sattle>`_ component.
+
+.. If there are topics related to developing this module (rather than using it), link to this from a toctree placed here.
+
+.. .. toctree::
+..    :maxdepth: 1
+
+.. _lsst.sattle-command-line-taskref:
+
+Task reference
+==============
+
+.. _lsst.sattle-pipeline-tasks:
+
+Pipeline tasks
+--------------
+
+.. lsst-pipelinetasks::
+   :root: lsst.sattle
+
+.. _lsst.sattle-tasks:
+
+Tasks
+-----
+
+.. lsst-tasks::
+   :root: lsst.sattle
+   :toctree: tasks
+
+.. _lsst.sattle-configs:
+
+Configurations
+--------------
+
+.. lsst-configs::
+   :root: lsst.sattle
+   :toctree: configs
+
+.. .. _lsst.sattle-scripts:
+
+.. Script reference
+.. ================
+
+.. .. TODO: Add an item to this toctree for each script reference topic in the scripts subdirectory.
+
+.. .. toctree::
+..    :maxdepth: 1
+
+.. .. _lsst.sattle-pyapi:
+
+Python API reference
+====================
+
+.. automodapi:: lsst.sattle
+   :no-main-docstr:
+   :no-inheritance-diagram:

doc/manifest.yaml

@@ -0,0 +1,12 @@
+# Documentation manifest.
+
+# List of names of Python modules in this package.
+# For each module there is a corresponding module doc subdirectory.
+modules:
+  - "lsst.sattle"
+
+# Name of the static content directories (subdirectories of `_static`).
+# Static content directories are usually named after the package.
+# Most packages do not need a static content directory (leave commented out).
+# statics:
+#   - "_static/sattle"

include/lsst/sattle.h

@@ -0,0 +1,31 @@
+// -*- LSST-C++ -*-
+/*
+ * This file is part of sattle.
+ *
+ * Developed for the LSST Data Management System.
+ * This product includes software developed by the LSST Project
+ * (https://www.lsst.org).
+ * See the COPYRIGHT file at the top-level directory of this distribution
+ * for details of code ownership.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/** \file
+  * \brief Include files for lsst::sattle.
+  */
+#ifndef LSST_SATTLE_H
+#define LSST_SATTLE_H
+
+#endif

lib/SConscript

@@ -0,0 +1,3 @@
+# -*- python -*-
+from lsst.sconsUtils import scripts
+scripts.BasicSConscript.lib()

pyproject.toml

@@ -0,0 +1,3 @@
+# Pytest configuration required to prevent pytest from looking for
+# configurations in parent directories. Can be empty.
+[tool.pytest.ini_options]

python/lsst/sattle/__init__.py

@@ -0,0 +1,22 @@
+# This file is part of sattle.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+from .version import *  # Generated by sconsUtils

setup.cfg

@@ -0,0 +1,10 @@
+[flake8]
+max-line-length = 110
+max-doc-length = 79
+ignore = E133, E226, E228, N802, N803, N806, N812, N813, N815, N816, W503
+exclude =
+  bin,
+  doc/conf.py,
+  **/*/__init__.py,
+  **/*/version.py,
+  tests/.tests

src/Starter.cc

@@ -0,0 +1,27 @@
+// -*- LSST-C++ -*-
+/*
+ * This file is part of sattle.
+ *
+ * Developed for the LSST Data Management System.
+ * This product includes software developed by the LSST Project
+ * (https://www.lsst.org).
+ * See the COPYRIGHT file at the top-level directory of this distribution
+ * for details of code ownership.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace lsst { sattle {
+
+}} // lsst::sattle

tests/SConscript

@@ -0,0 +1,3 @@
+# -*- python -*-
+from lsst.sconsUtils import scripts
+scripts.BasicSConscript.tests(pyList=[])

ups/sattle.cfg

@@ -0,0 +1,24 @@
+# -*- python -*-
+
+import lsst.sconsUtils
+
+# Dependencies that provide header files and or libraries should be included here.
+# Pure-Python dependencies do not need to be included.
+# Packages that use pybind11 or boost_tests should declare them as build dependencies.
+# Otherwise, the rules for which packages to list here are the same as those for
+# table files.
+dependencies = {
+    "required": ["utils", "ndarray"],
+    "buildRequired": ["boost_test", "pybind11", "ndarray", "pex_exceptions"],
+    "optional": [],
+    "buildOptional": [],
+}
+
+# For packages that build a C++ library and a Python module, the below should be sufficient.
+# Pure-Python packages should set headers=[], libs=[] (not libs=None). and hasSwigFiles=False.
+# For more information, see the sconsUtils Doxygen documentation.
+config = lsst.sconsUtils.Configuration(
+    __file__,
+    headers=["lsst/sattle.h"],
+    hasDoxygenInclude=False,
+)

ups/sattle.table

@@ -0,0 +1,13 @@
+# List EUPS dependencies of this package here.
+# - Any package whose API is used directly should be listed explicitly.
+# - Common third-party packages can be assumed to be recursively included by
+#   the "base" package.
+setupRequired(base)
+
+# The following is boilerplate for all packages.
+# See https://dmtn-001.lsst.io for details on LSST_LIBRARY_PATH.
+# Pure-Python packages only need the last line.
+envPrepend(LD_LIBRARY_PATH, ${PRODUCT_DIR}/lib)
+envPrepend(DYLD_LIBRARY_PATH, ${PRODUCT_DIR}/lib)
+envPrepend(LSST_LIBRARY_PATH, ${PRODUCT_DIR}/lib)
+envPrepend(PYTHONPATH, ${PRODUCT_DIR}/python)