Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-38569

Move cp_verify notebooks out of examples/

    XMLWordPrintable

    Details

    • Story Points:
      4
    • Epic Link:
    • Team:
      Data Release Production
    • Urgent?:
      No

      Description

      There are many jupyter notebooks in cp_verify/examples. Per RFC-870, we shouldn't be storing anything in `examples/`, due to that path not being run in CI and easily bit-rotting. cp_verify's usage of these notebooks is more like documentation and demonstration of successful of pipeline output.

      DM-33557 was filed to get some of this code running in CI; this ticket is to move it to another location, independent of whether they are executed in CI. doc/_static/ isn't a terrible place, but ask in #dm-doc-support for other ideas, since these aren't exactly documentation.

        Attachments

        1. screenshot-1.png
          screenshot-1.png
          465 kB
        2. screenshot-2.png
          screenshot-2.png
          334 kB
        3. screenshot-3.png
          screenshot-3.png
          142 kB
        4. screenshot-4.png
          screenshot-4.png
          399 kB
        5. screenshot-5.png
          screenshot-5.png
          124 kB

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-35962 Remove examples/ from all packages

          • Done

          Improvement - An improvement or enhancement to an existing feature or task. DM-33557 Add cp_verify tests to ci_cpp

          • In Review

          RFC - An issue whose primary purpose is to advertise an intent and allow stakeholders to comment. RFC-870 Remove examples/ directory from most packages and templates

          • Implemented

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            plazas Andrés Alejandro Plazas Malagón added a comment - - edited

            The notebooks have been moved to a new location, as per the ticket requests. I have asked for clarification in the comments that show how to use and install papermill (and also full documentation will be addressed in DM-36407), and the addressing of minor bugs before merging.

            Show
            plazas Andrés Alejandro Plazas Malagón added a comment - - edited The notebooks have been moved to a new location, as per the ticket requests. I have asked for clarification in the comments that show how to use and install papermill (and also full documentation will be addressed in DM-36407 ), and the addressing of minor bugs before merging.
            Hide
            Permalink
            plazas Andrés Alejandro Plazas Malagón added a comment -

            Bugs:

            • Defects notebook:
            • PTC notebook:
            • PTC V2 notebook:
            • PTC with linearity:

            Show
            plazas Andrés Alejandro Plazas Malagón added a comment - Bugs: Defects notebook: PTC notebook: PTC V2 notebook: PTC with linearity:

              People

              Assignee:
              czw Christopher Waters
              Reporter:
              Parejkoj John Parejko
              Reviewers:
              Andrés Alejandro Plazas Malagón
              Watchers:
              Andrés Alejandro Plazas Malagón, John Parejko, Jonathan Sick, Merlin Fisher-Levine, Yusra AlSayyad
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.