dkist-processing-cryonirsp 0.0.75__tar.gz → 0.0.76__tar.gz

{dkist_processing_cryonirsp-0.0.75 → dkist_processing_cryonirsp-0.0.76}/.pre-commit-config.yaml

@@ -27,3 +27,7 @@ repos:
         args:
             - --convention=numpy
             - --add-ignore=D105
+-   repo: https://bitbucket.org/dkistdc/pre-commit-hooks
+    rev: v1.0.0
+    hooks:
+    -   id: calibration-workflow-name

{dkist_processing_cryonirsp-0.0.75 → dkist_processing_cryonirsp-0.0.76}/CHANGELOG.rst

@@ -1,3 +1,12 @@
+v0.0.76 (2024-08-05)
+====================
+
+Documentation
+-------------
+
+- Add pre-commit hook for documentation, add missing workflow documentation and update README.rst. (`#139 <https://bitbucket.org/dkistdc/dkist-processing-cryonirsp/pull-requests/139>`__)
+
+
 v0.0.75 (2024-07-31)
 ====================
 

{dkist_processing_cryonirsp-0.0.75 → dkist_processing_cryonirsp-0.0.76}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist_processing_cryonirsp
-Version: 0.0.75
+Version: 0.0.76
 Summary: Science processing code for the Cryo-NIRSP instrument on DKIST
 Home-page: https://bitbucket.org/dkistdc/dkist_processing_cryonirsp/src/main/
 Author: NSO / AURA
@@ -26,7 +26,7 @@ The dkist-processing-cryonirsp library contains the implementation of the cryoni
 `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ framework and
 `dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_ Tasks.
 
-The recommended project structure is to separate tasks and workflows into seperate packages.  Having the workflows
+The recommended project structure is to separate tasks and workflows into separate packages.  Having the workflows
 in their own package facilitates using the build_utils to test the integrity of those workflows in the unit test.
 
 Calibration Pipeline
@@ -34,7 +34,7 @@ Calibration Pipeline
 
 Build
 -----
-Artifacts are built through `bitbucket pipelines <bitbucket-pipelines.yml>`_.
+Artifacts are built through Bitbucket Pipelines.
 
 The pipeline can be used in other repos with a modification of the package and artifact locations
 to use the names relevant to the target repo.
@@ -81,7 +81,7 @@ The fields have the following meanings:
 * ``<TYPE>``: This is the type of the change and must be one of the values described below.
 * ``<COUNTER>``: This is an optional field, if you make more than one change of the same type you can append a counter to the subsequent changes, i.e. ``100.bugfix.rst`` and ``100.bugfix.1.rst`` for two bugfix changes in the same PR.
 
-The list of possible types is defined the the towncrier section of ``pyproject.toml``, the types are:
+The list of possible types is defined in the towncrier section of ``pyproject.toml``, the types are:
 
 * ``feature``: This change is a new code feature.
 * ``bugfix``: This is a change which fixes a bug.
@@ -128,7 +128,7 @@ as other fragments, but are always called::
   <PR NUMBER | +>.science[.<COUNTER>].rst
 
 In the case that a single pull request encapsulates the entirety of the scientific change then the first field should
-be that PR number (same as the normal CHANGELOG). If, however, there is not a simple mapping from a single PR to a scienctific
+be that PR number (same as the normal CHANGELOG). If, however, there is not a simple mapping from a single PR to a scientific
 change then use the character "+" instead; this will create a changelog entry with no associated PR. For example:
 
 .. code-block:: bash

{dkist_processing_cryonirsp-0.0.75 → dkist_processing_cryonirsp-0.0.76}/README.rst

@@ -7,7 +7,7 @@ The dkist-processing-cryonirsp library contains the implementation of the cryoni
 `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ framework and
 `dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_ Tasks.
 
-The recommended project structure is to separate tasks and workflows into seperate packages.  Having the workflows
+The recommended project structure is to separate tasks and workflows into separate packages.  Having the workflows
 in their own package facilitates using the build_utils to test the integrity of those workflows in the unit test.
 
 Calibration Pipeline
@@ -15,7 +15,7 @@ Calibration Pipeline
 
 Build
 -----
-Artifacts are built through `bitbucket pipelines <bitbucket-pipelines.yml>`_.
+Artifacts are built through Bitbucket Pipelines.
 
 The pipeline can be used in other repos with a modification of the package and artifact locations
 to use the names relevant to the target repo.
@@ -62,7 +62,7 @@ The fields have the following meanings:
 * ``<TYPE>``: This is the type of the change and must be one of the values described below.
 * ``<COUNTER>``: This is an optional field, if you make more than one change of the same type you can append a counter to the subsequent changes, i.e. ``100.bugfix.rst`` and ``100.bugfix.1.rst`` for two bugfix changes in the same PR.
 
-The list of possible types is defined the the towncrier section of ``pyproject.toml``, the types are:
+The list of possible types is defined in the towncrier section of ``pyproject.toml``, the types are:
 
 * ``feature``: This change is a new code feature.
 * ``bugfix``: This is a change which fixes a bug.
@@ -109,7 +109,7 @@ as other fragments, but are always called::
   <PR NUMBER | +>.science[.<COUNTER>].rst
 
 In the case that a single pull request encapsulates the entirety of the scientific change then the first field should
-be that PR number (same as the normal CHANGELOG). If, however, there is not a simple mapping from a single PR to a scienctific
+be that PR number (same as the normal CHANGELOG). If, however, there is not a simple mapping from a single PR to a scientific
 change then use the character "+" instead; this will create a changelog entry with no associated PR. For example:
 
 .. code-block:: bash

{dkist_processing_cryonirsp-0.0.75 → dkist_processing_cryonirsp-0.0.76}/dkist_processing_cryonirsp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkist-processing-cryonirsp
-Version: 0.0.75
+Version: 0.0.76
 Summary: Science processing code for the Cryo-NIRSP instrument on DKIST
 Home-page: https://bitbucket.org/dkistdc/dkist_processing_cryonirsp/src/main/
 Author: NSO / AURA
@@ -26,7 +26,7 @@ The dkist-processing-cryonirsp library contains the implementation of the cryoni
 `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ framework and
 `dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_ Tasks.
 
-The recommended project structure is to separate tasks and workflows into seperate packages.  Having the workflows
+The recommended project structure is to separate tasks and workflows into separate packages.  Having the workflows
 in their own package facilitates using the build_utils to test the integrity of those workflows in the unit test.
 
 Calibration Pipeline
@@ -34,7 +34,7 @@ Calibration Pipeline
 
 Build
 -----
-Artifacts are built through `bitbucket pipelines <bitbucket-pipelines.yml>`_.
+Artifacts are built through Bitbucket Pipelines.
 
 The pipeline can be used in other repos with a modification of the package and artifact locations
 to use the names relevant to the target repo.
@@ -81,7 +81,7 @@ The fields have the following meanings:
 * ``<TYPE>``: This is the type of the change and must be one of the values described below.
 * ``<COUNTER>``: This is an optional field, if you make more than one change of the same type you can append a counter to the subsequent changes, i.e. ``100.bugfix.rst`` and ``100.bugfix.1.rst`` for two bugfix changes in the same PR.
 
-The list of possible types is defined the the towncrier section of ``pyproject.toml``, the types are:
+The list of possible types is defined in the towncrier section of ``pyproject.toml``, the types are:
 
 * ``feature``: This change is a new code feature.
 * ``bugfix``: This is a change which fixes a bug.
@@ -128,7 +128,7 @@ as other fragments, but are always called::
   <PR NUMBER | +>.science[.<COUNTER>].rst
 
 In the case that a single pull request encapsulates the entirety of the scientific change then the first field should
-be that PR number (same as the normal CHANGELOG). If, however, there is not a simple mapping from a single PR to a scienctific
+be that PR number (same as the normal CHANGELOG). If, however, there is not a simple mapping from a single PR to a scientific
 change then use the character "+" instead; this will create a changelog entry with no associated PR. For example:
 
 .. code-block:: bash

{dkist_processing_cryonirsp-0.0.75 → dkist_processing_cryonirsp-0.0.76}/dkist_processing_cryonirsp.egg-info/SOURCES.txt

@@ -110,7 +110,9 @@ docs/changelog.rst
 docs/ci_science_calibration.rst
 docs/conf.py
 docs/index.rst
+docs/l0_to_l1_cryonirsp_ci-full-trial.rst
 docs/l0_to_l1_cryonirsp_ci.rst
+docs/l0_to_l1_cryonirsp_sp-full-trial.rst
 docs/l0_to_l1_cryonirsp_sp.rst
 docs/linearization.rst
 docs/make.bat

{dkist_processing_cryonirsp-0.0.75 → dkist_processing_cryonirsp-0.0.76}/docs/index.rst

@@ -7,9 +7,8 @@
     self
     l0_to_l1_cryonirsp_ci
     l0_to_l1_cryonirsp_sp
-    autoapi/index
-    requirements_table
-    changelog
+    l0_to_l1_cryonirsp_ci-full-trial
+    l0_to_l1_cryonirsp_sp-full-trial
     scientific_changelog
     linearization
     bad_pixel_calibration
@@ -17,3 +16,6 @@
     beam_angle_calculation
     ci_science_calibration
     sp_science_calibration
+    autoapi/index
+    requirements_table
+    changelog

dkist_processing_cryonirsp-0.0.76/docs/l0_to_l1_cryonirsp_ci-full-trial.rst

@@ -0,0 +1,10 @@
+l0_to_l1_cryonirsp_ci-full-trial
+================================
+
+This trial workflow is designed for pipeline testing internal to the DKIST Data Center (DC). It runs the full science
+pipeline, but stops short of publishing the results or activating downstream DC services. The pipeline products
+are transferred to an internal location where they can be examined by DC personnel or DKIST scientists.
+
+For more detail on each workflow task, you can click on the task in the diagram.
+
+.. workflow_diagram:: dkist_processing_cryonirsp.workflows.trial_workflows.full_trial_ci_pipeline

dkist_processing_cryonirsp-0.0.76/docs/l0_to_l1_cryonirsp_sp-full-trial.rst

@@ -0,0 +1,10 @@
+l0_to_l1_cryonirsp_sp-full-trial
+================================
+
+This trial workflow is designed for pipeline testing internal to the DKIST Data Center (DC). It runs the full science
+pipeline, but stops short of publishing the results or activating downstream DC services. The pipeline products
+are transferred to an internal location where they can be examined by DC personnel or DKIST scientists.
+
+For more detail on each workflow task, you can click on the task in the diagram.
+
+.. workflow_diagram:: dkist_processing_cryonirsp.workflows.trial_workflows.full_trial_sp_pipeline