-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b311bdb
Showing
17 changed files
with
887 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
name: lint | ||
|
||
on: | ||
- push | ||
- pull_request | ||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.7 | ||
|
||
- name: Install | ||
run: pip install -r <(curl https://raw.githubusercontent.com/lsst/linting/main/requirements.txt) | ||
|
||
- name: Run linter | ||
run: flake8 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Copyright 2024 The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
##################### | ||
obs_fiberspectrograph | ||
##################### | ||
|
||
``obs_fiberspectrograph`` is a package in the `LSST Science Pipelines <https://pipelines.lsst.io>`_. | ||
|
||
.. Add a brief (few sentence) description of what this package provides. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# -*- python -*- | ||
from lsst.sconsUtils import scripts | ||
# Python-only package | ||
scripts.BasicSConstruct("obs_fiberspectrograph", disableCc=True, noCfgFile=True) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# -*- python -*- | ||
from lsst.sconsUtils import scripts | ||
scripts.BasicSConscript.shebang() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Doxygen products | ||
html | ||
xml | ||
*.tag | ||
*.inc | ||
doxygen.conf | ||
|
||
# Sphinx products | ||
_build | ||
py-api |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 = "obs_fiberspectrograph" | ||
html_theme_options["logotext"] = project | ||
html_title = project | ||
html_short_title = project |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
########################################### | ||
obs_fiberspectrograph documentation preview | ||
########################################### | ||
|
||
.. This page is for local development only. It isn't published to pipelines.lsst.io. | ||
.. Link the index pages of package and module documentation directions (listed in manifest.yaml). | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
lsst.obs.fiberspectrograph/index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
.. py:currentmodule:: lsst.obs.fiberspectrograph | ||
.. _lsst.obs.fiberspectrograph: | ||
|
||
########################## | ||
lsst.obs.fiberspectrograph | ||
########################## | ||
|
||
.. Paragraph that describes what this Python module does and links to related modules and frameworks. | ||
.. .. _lsst.obs.fiberspectrograph-using: | ||
.. Using lsst.obs.fiberspectrograph | ||
.. ================================ | ||
.. toctree linking to topics related to using the module's APIs. | ||
.. .. toctree:: | ||
.. :maxdepth: 1 | ||
.. _lsst.obs.fiberspectrograph-contributing: | ||
|
||
Contributing | ||
============ | ||
|
||
``lsst.obs.fiberspectrograph`` is developed at https://github.com/lsst/obs_fiberspectrograph. | ||
You can find Jira issues for this module under the `obs_fiberspectrograph <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20obs_fiberspectrograph>`_ 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.obs.fiberspectrograph-scripts: | ||
.. Script reference | ||
.. ================ | ||
.. .. TODO: Add an item to this toctree for each script reference topic in the scripts subdirectory. | ||
.. .. toctree:: | ||
.. :maxdepth: 1 | ||
.. .. _lsst.obs.fiberspectrograph-pyapi: | ||
Python API reference | ||
==================== | ||
|
||
.. automodapi:: lsst.obs.fiberspectrograph | ||
:no-main-docstr: | ||
:no-inheritance-diagram: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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.obs.fiberspectrograph" | ||
|
||
# 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/obs_fiberspectrograph" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# This file is part of obs_fiberspectrograph. | ||
# | ||
# 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
[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 | ||
|
||
[tool:pytest] | ||
addopts = --flake8 | ||
flake8-ignore = E133 E226 E228 N802 N803 N806 N812 N813 N815 N816 W503 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# -*- python -*- | ||
from lsst.sconsUtils import scripts | ||
scripts.BasicSConscript.tests(pyList=[]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# 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. | ||
envPrepend(PYTHONPATH, ${PRODUCT_DIR}/python) |