dkist-processing-trend 0.1.0__py3-none-any.whl

docs/conf.py

@@ -0,0 +1,57 @@
+"""Configuration file for the Sphinx documentation builder."""
+
+# -- stdlib imports ------------------------------------------------------------
+import importlib
+import sys
+import warnings
+from importlib.metadata import distribution
+
+from dkist_sphinx_theme.conf import *
+from dkist_sphinx_theme.create_intersphinx_mapping import create_intersphinx_mapping
+from packaging.version import Version
+
+# Need a name for the overall repo
+# __name__ where this code executes is "builtins" so that is no help
+repo_name = "dkist-processing-trend"
+package_name = repo_name.replace("-", "_")
+
+dist = distribution(package_name)
+package = importlib.import_module(package_name)
+
+# -- Check for docs dependencies ----------------------------------------------------
+missing_requirements = missing_dependencies_by_extra(package_name, extras=["docs"])
+if missing_requirements["docs"]:
+    print(
+        f"The {' '.join(missing_requirements['docs'])} package(s) could not be found and "
+        "is needed to build the documentation, please install the 'docs' requirements."
+    )
+    sys.exit(1)
+
+# auto api parameters that cannot be moved into the theme:
+autoapi_dirs = [Path(package.__file__).parent]
+# Uncomment this for debugging
+# autoapi_keep_files = True
+
+# -- Options for intersphinx extension -----------------------------------------
+intersphinx_mapping = create_intersphinx_mapping(repo_name) | {
+    "lmfit": ("https://lmfit.github.io/lmfit-py", None),
+    "sklearn": ("https://scikit-learn.org/stable/", None),
+    "skimage": ("https://scikit-image.org/docs/stable", None),
+}
+# Remaining sphinx settings are in dkist-sphinx-theme conf.py
+
+# -- Project information -------------------------------------------------------
+project = "DKIST-PROCESSING-TREND"
+
+# The full version, including alpha/beta/rc tags
+dkist_version = Version(dist.version)
+is_release = not (dkist_version.is_prerelease or dkist_version.is_devrelease)
+# We want to ignore all warnings in a release version.
+if is_release:
+    warnings.simplefilter("ignore")
+
+# Extensions so we can create the reqmts table and the workflow diagram
+extensions += [
+    "dkist_sphinx_theme.create_requirements_table",
+    "dkist_sphinx_theme.create_workflow_diagram",
+]

docs/index.rst

@@ -0,0 +1,10 @@
+.. include:: landing_page.rst
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    self
+    l0_to_trend_visp_polcal
+    autoapi/index
+    requirements_table

docs/l0_to_trend_visp_polcal.rst

@@ -0,0 +1,4 @@
+l0_to_trend_visp_polcal
+=======================
+
+.. workflow_diagram:: dkist_processing_trend.workflows.visp.visp_polcal_pipeline

docs/landing_page.rst

@@ -0,0 +1,11 @@
+Overview
+========
+
+`dkist-processing-trend` contains workflows designed to process DKIST calibration data over large periods of time.
+The results of these workflows are homogeneous across time and are designed to enable analysis of trends in instrument and
+telescope performance.
+
+Unlike the L1 pipelines, this repo contains workflows for all polarimetric DKIST instruments. Another key difference in workflow
+construction is that splitting input data into instrument arms happens at the workflow level.
+
+These documentation pages serve primarily as a record of the API and individual workflows.

docs/requirements_table.rst

@@ -0,0 +1,8 @@
+Package Requirements
+====================
+
+This table shows the main Python packages and their respective
+versions that were used to build the calibration codes documented
+here. All of these packages are available on `PyPI <https://pypi.org>`_.
+
+.. requirements_table:: dkist-processing-trend