-
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 2a0e8d2
Showing
14 changed files
with
568 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,11 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" | ||
|
||
- package-ecosystem: "pip" | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" |
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 @@ | ||
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: tstn-047 | ||
secrets: | ||
ltd_username: ${{ secrets.LTD_USERNAME }} | ||
ltd_password: ${{ secrets.LTD_PASSWORD }} |
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,5 @@ | ||
_build/ | ||
.technote/ | ||
.tox/ | ||
venv/ | ||
.venv/ |
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 @@ | ||
repos: | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v4.5.0 | ||
hooks: | ||
# - id: trailing-whitespace | ||
- id: check-yaml | ||
- id: check-toml |
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,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 |
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,45 @@ | ||
[![Website](https://img.shields.io/badge/tstn--047-lsst.io-brightgreen.svg)](https://tstn-047.lsst.io) | ||
[![CI](https://github.com/lsst-tstn/tstn-047/actions/workflows/ci.yaml/badge.svg)](https://github.com/lsst-tstn/tstn-047/actions/workflows/ci.yaml) | ||
|
||
# Operator Control of Rubin Observatory NVR Camera Infrared Illuminators | ||
|
||
## TSTN-047 | ||
|
||
A solution is proposed to provide web dashboard control of the infrared illuminators on the UniFi web cameras deployed throughout the observatory, with needing to provide and admin-level UniFi account for each operator. | ||
|
||
**Links:** | ||
|
||
- Publication URL: https://tstn-047.lsst.io | ||
- Alternative editions: https://tstn-047.lsst.io/v | ||
- GitHub repository: https://github.com/lsst-tstn/tstn-047 | ||
- Build system: https://github.com/lsst-tstn/tstn-047/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 | ||
|
||
```sh | ||
git clone https://github.com/lsst-tstn/tstn-047 | ||
cd tstn-047 | ||
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://tstn-047.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://tstn-047.lsst.io/v. | ||
|
||
## Editing this technical note | ||
|
||
The main content of this technote is in `index.md` (a Markdown file parsed as [CommonMark/MyST](https://myst-parser.readthedocs.io/en/latest/index.html)). | ||
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. |
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 @@ | ||
# See the Documenteer docs for how to customize conf.py: | ||
# https://documenteer.lsst.io/technotes/ | ||
|
||
from documenteer.conf.technote import * # noqa F401 F403 |
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 @@ | ||
# Operator Control of Rubin Observatory NVR Camera Infrared Illuminators | ||
|
||
```{abstract} | ||
A solution is proposed to provide web dashboard control of the infrared illuminators on the UniFi web cameras deployed throughout the observatory, with needing to provide and admin-level UniFi account for each operator. | ||
``` | ||
|
||
## 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. |
Empty file.
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 @@ | ||
documenteer[technote]>=1.0.0a13 |
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,23 @@ | ||
[technote] | ||
id = "TSTN-047" | ||
series_id = "TSTN" | ||
canonical_url = "https://tstn-047.lsst.io" | ||
github_url = "https://github.com/lsst-tstn/tstn-047" | ||
github_default_branch = "main" | ||
date_created = 2024-07-24T23:49:19Z | ||
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 = "Fritz" | ||
name.family = "Mueller" | ||
internal_id = "muellerf" | ||
orcid = "https://orcid.org/0000-0002-7061-4644" | ||
[[technote.authors.affiliations]] | ||
name = "SLAC National Accelerator Laboratory" | ||
internal_id = "SLAC" | ||
address = "2575 Sand Hill Rd., Menlo Park, CA 94025, USA" |
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,29 @@ | ||
[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 |