Skip to content

Commit

Permalink
Add repository skeleton.
Browse files Browse the repository at this point in the history
  • Loading branch information
kfindeisen committed Jul 11, 2017
1 parent 91839e9 commit 9872711
Show file tree
Hide file tree
Showing 14 changed files with 157 additions and 2 deletions.
19 changes: 19 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
*.o
*.os
*.pyc
*.so
*~
.cache
.sconf_temp
.sconsign.dblite
bin/*.py
config.log
doc/*.inc
doc/*.tag
doc/doxygen.conf
doc/html
doc/xml
tests/.cache
tests/.tests
ups/*.cfgc
version.py
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# verify_ap
Verification test framework for DM Alert Production
# lsst.verify.ap

This package manages end-to-end testing and metric generation for the LSST DM Alert Production pipeline. Metrics are tested against both project- and lower-level requirements, and will be deliverable to the SQuaSH metrics service.

`verify_ap` is part of the LSST Science Pipelines. You can learn how to install the Pipelines at https://pipelines.lsst.io/install/index.html.
7 changes: 7 additions & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
_build
py-api
api
html
*.tag
*.inc
doxygen.conf
64 changes: 64 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"

.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
rm -rf py-api

.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

ltd: html
ltd-mason-travis --html-dir $(BUILDDIR)/html


.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."

.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."
3 changes: 3 additions & 0 deletions doc/SConscript
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# -*- python -*-
from lsst.sconsUtils import scripts
scripts.BasicSConscript.doc()
18 changes: 18 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/usr/bin/env python

from documenteer.sphinxconfig.stackconf import build_package_configs

import lsst.afw

_g = globals()
_g.update(build_package_configs(
project_name="afw",
copyright="2017 Association of Univerities for "
"Research in Astronomy, Inc.",
version=lsst.afw.version.__version__,
doxygen_xml_dirname=None))

intersphinx_mapping['astropy'] = ('http://docs.astropy.org/en/stable', None)

# DEBUG only
automodsumm_writereprocessed = False
5 changes: 5 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Sphinx>=1.4.5
astropy-helpers>=1.2
documenteer>=0.1.9
sphinx-rtd-theme==0.1.9
ltd-mason==0.2.1
4 changes: 4 additions & 0 deletions python/lsst/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from __future__ import absolute_import

import pkgutil, lsstimport
__path__ = pkgutil.extend_path(__path__, __name__)
4 changes: 4 additions & 0 deletions python/lsst/verify/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from __future__ import absolute_import

import pkgutil, lsstimport
__path__ = pkgutil.extend_path(__path__, __name__)
1 change: 1 addition & 0 deletions python/lsst/verify/ap/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from __future__ import absolute_import
3 changes: 3 additions & 0 deletions tests/SConscript
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# -*- python -*-
from lsst.sconsUtils import scripts
scripts.BasicSConscript.tests()
2 changes: 2 additions & 0 deletions ups/verify_ap.build
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
@LSST BUILD@ &&
build_lsst @PRODUCT@ @VERSION@ @REPOVERSION@
12 changes: 12 additions & 0 deletions ups/verify_ap.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# -*- python -*-

import lsst.sconsUtils

dependencies = {
}

config = lsst.sconsUtils.Configuration(
__file__,
hasDoxygenInclude=False,
hasSwigFiles=False,
)
10 changes: 10 additions & 0 deletions ups/verify_ap.table
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
setupRequired(python)
setupRequired(python_future)

setupRequired(utils)

setupRequired(pyyaml)
setupRequired(verify)

envPrepend(PYTHONPATH, ${PRODUCT_DIR}/python)
envPrepend(PATH, ${PRODUCT_DIR}/bin)

0 comments on commit 9872711

Please sign in to comment.