Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CDAT Migration Phase 2 - Port cdp.viewer.OutputViewer from cdp package #628

Closed
tomvothecoder opened this issue Nov 10, 2022 · 0 comments · Fixed by #773
Closed

CDAT Migration Phase 2 - Port cdp.viewer.OutputViewer from cdp package #628

tomvothecoder opened this issue Nov 10, 2022 · 0 comments · Fixed by #773
Labels
cdat-migration-fy24 CDAT Migration FY24 Task Hard A subjectively hard task.

Comments

@tomvothecoder
Copy link
Collaborator

tomvothecoder commented Nov 10, 2022

I anticipate it will take a lot of time and work to write a new HTML output viewer from scratch using another Python library.

As a short-term solution, we should port cdp.cdp_viewer.py straight from the cdp package instead. It does not seem like there is that much code that needs to be ported over. We also need to add the output_viewer dependency based on the cdp-feedstock recipe.

A new PR for this issue can merged directly to main.

cdp references:

35 results - 20 files

conda-env/ci.yml:
  15    - cartopy_offlinedata
  16:   - cdp
  17    - cdms2

conda-env/dev.yml:
  13    - cartopy_offlinedata=0.2.4
  14:   - cdp=1.7.0
  15    - cdms2=3.1.5

docs/source/index.rst:
  55     diagnostics package through a unifying framework: `Community
  56:    Diagnostics Package (CDP) <https://github.com/CDAT/cdp>`_.
  57  -  is flexible for user-specified diagnostics and configuration for

docs/source/dev_guide/adding-new-diags-sets.rst:
  618          from .default_viewer import create_metadata
  619:         from cdp.cdp_viewer import OutputViewer
  620  

  682  
  683: We use the CDP Viewer to create the webpages.
  684  **This is not needed! Use whatever you want to create the webpages.**

docs/source/dev_guide/index.rst:
  10     adding-new-diags-sets
  11:    using-cdp-output-viewer
  12     releasing-e3sm-diags

docs/source/dev_guide/using-cdp-output-viewer.rst:
    1: How to use the CDP Output Viewer
    2  ================================

    6  - The basic framework of the `ESGF Output Viewer <https://github.com/ESGF/output_viewer>`__, consisting of indices, pages, groups, rows, and columns.
    7: - The process of using the `CDP Output Viewer <https://github.com/CDAT/cdp/blob/master/cdp/cdp_viewer.py>`__ (``cdp_viewer``), including explanations and examples related to the relevant functions.
    8  
    9:   - CDP Output Viewer is based on the ESGF Output Viewer
   10  

   86  
   87: Using CDP Output Viewer (``cdp_viewer``)
   88  ----------------------------------------

  101  
  102:     from cdp.cdp_viewer import OutputViewer
  103  

  124  
  125:     Viewer HTML generated at /Users/shaheen2/github/cdp/jupyter/index.html. Would you like to open in a browser? y/[n]: y
  126  


e3sm_diags/parameter/core_parameter.py:
  2  
  3: import cdp.cdp_parameter
  4  
  5  
  6: class CoreParameter(cdp.cdp_parameter.CDPParameter):
  7      def __init__(self):

e3sm_diags/parser/core_parser.py:
  1: import cdp.cdp_parser
  2  

  5  
  6: class CoreParser(cdp.cdp_parser.CDPParser):
  7      def __init__(self, *args, **kwargs):

e3sm_diags/viewer/annual_cycle_zonal_mean_viewer.py:
  2  
  3: from cdp.cdp_viewer import OutputViewer
  4  

e3sm_diags/viewer/area_mean_time_series_viewer.py:
  2  
  3: from cdp.cdp_viewer import OutputViewer
  4  

e3sm_diags/viewer/arm_diags_viewer.py:
  2  
  3: from cdp.cdp_viewer import OutputViewer
  4  

e3sm_diags/viewer/default_viewer.py:
  12  import numpy
  13: from cdp.cdp_viewer import OutputViewer
  14  

e3sm_diags/viewer/enso_diags_viewer.py:
  3  
  4: from cdp.cdp_viewer import OutputViewer
  5  

e3sm_diags/viewer/mean_2d_viewer.py:
  2  
  3: from cdp.cdp_viewer import OutputViewer
  4  

e3sm_diags/viewer/qbo_viewer.py:
  2  
  3: from cdp.cdp_viewer import OutputViewer
  4  

e3sm_diags/viewer/streamflow_viewer.py:
  2  
  3: from cdp.cdp_viewer import OutputViewer
  4  

e3sm_diags/viewer/tc_analysis_viewer.py:
  2  
  3: from cdp.cdp_viewer import OutputViewer
  4  

Related to #607

@tomvothecoder tomvothecoder changed the title Replace cdp output viewer with another output viewer framework CDAT Migration Phase 2 - Replace cdp..viewer.OutputViewer with another output viewer framework Nov 30, 2022
@tomvothecoder tomvothecoder changed the title CDAT Migration Phase 2 - Replace cdp..viewer.OutputViewer with another output viewer framework CDAT Migration Phase 2 - Replace cdp.viewer.OutputViewer Nov 30, 2022
@tomvothecoder tomvothecoder changed the title CDAT Migration Phase 2 - Replace cdp.viewer.OutputViewer CDAT Migration Phase 3 - Replace cdp.viewer.OutputViewer Nov 30, 2022
@tomvothecoder tomvothecoder changed the title CDAT Migration Phase 3 - Replace cdp.viewer.OutputViewer CDAT Migration Phase 2 - Replace cdp.viewer.OutputViewer Dec 1, 2022
@tomvothecoder tomvothecoder modified the milestones: FY25 Q1 (10/01/24 - 12/31/24), FY24 Q4 (07/01/24 - 09/30/24) Sep 26, 2023
@tomvothecoder tomvothecoder added cdat-migration-fy24 CDAT Migration FY24 Task and removed refactor labels Sep 26, 2023
@tomvothecoder tomvothecoder modified the milestones: FY24 Q4 (07/01/24 - 09/30/24), FY24 (Multi-Quarter) Sep 26, 2023
@tomvothecoder tomvothecoder added the Hard A subjectively hard task. label Sep 26, 2023
@tomvothecoder tomvothecoder changed the title CDAT Migration Phase 2 - Replace cdp.viewer.OutputViewer CDAT Migration Phase 2 - Port cdp.viewer.OutputViewer from cdp package Jan 3, 2024
@tomvothecoder tomvothecoder modified the milestones: FY24 (Multi-Quarter), FY24 Q2 (01/01/24 - 03/31/24) Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cdat-migration-fy24 CDAT Migration FY24 Task Hard A subjectively hard task.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant