Skip to content

Commit 687ac6c

Browse files
authored
docs: update info on landing page
* update info on landing page * quickview landing page: clarify plots are maps
1 parent dab13fe commit 687ac6c

File tree

1 file changed

+41
-75
lines changed
  • src/e3sm_quickview/components

1 file changed

+41
-75
lines changed

src/e3sm_quickview/components/doc.py

Lines changed: 41 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -177,26 +177,36 @@ def __init__(self):
177177
html.A(
178178
"QuickView",
179179
classes="text-primary text-decoration-none",
180-
href="https://quickview.readthedocs.io/en/latest/",
180+
href="https://kitware.github.io/QuickView/guides/quickview/",
181181
target="_blank",
182182
)
183183

184184
Paragraph(f"""
185-
{Bold("EAM QuickView")} is an open-source, interactive visualization
186-
tool designed for scientists working with the atmospheric component
187-
of the {Link("Energy Exascale Earth System Model (E3SM)", "https://e3sm.org/")},
188-
known as the E3SM Atmosphere Model (EAM).
189-
Its Python- and {Link("Trame", "https://www.kitware.com/trame/")}-based
190-
Graphical User Interface (GUI) provides intuitive access to {Link("ParaView's", "https://www.paraview.org/")} powerful analysis
191-
and visualization capabilities, without the steep learning curve.
185+
{Bold("QuickView")} is an open-source, interactive visualization
186+
tool designed to help Earth system modelers take a quick look at
187+
a collection of physical quantities in their simulation files.
188+
The physical quantities are presented in the form of global or regional maps.
189+
Currently, QuickView supports only the cubed-sphere "physics" grids,
190+
i.e., the ne*pg2 meshes used by the atmosphere component of the
191+
{Link("Energy Exascale Earth System Model (E3SM)","https://e3sm.org/")},
192+
but extensions to other grids are underway.
193+
QuickView's Python and {Link("trame", "https://www.kitware.com/trame/")}-based
194+
graphical User Interface (UI) provides the users with intuitive access to
195+
{Link("ParaView", "https://www.paraview.org/")}'s powerful analysis
196+
and visualization capabilities without requiring a steep learning curve.
197+
A detailed {Bold("User's Guide")} can be found through
198+
{Link("this link","https://kitware.github.io/QuickView/guides/quickview/")}.
199+
{Bold("Bug reports")} and feature requests can be submitted on
200+
{Link("GitHub","https://github.com/Kitware/QuickView/issues")}.
192201
""")
193202

194-
v3.VImg(
195-
classes="rounded-lg",
196-
src=ASSETS.banner,
197-
)
203+
# v3.VImg(
204+
# classes="rounded-lg",
205+
# src=ASSETS.banner,
206+
# )
207+
198208

199-
Title("Getting started")
209+
Title("Toolbar Icons")
200210

201211
with v3.VRow():
202212
with v3.VCol(cols=6):
@@ -212,7 +222,7 @@ def __init__(self):
212222
ToolAnimation()
213223
ToolStateImportExport()
214224

215-
Title("Keyboard shortcuts")
225+
Title("Keyboard Shortcuts")
216226

217227
with v3.VRow():
218228
with v3.VCol(cols=6):
@@ -329,68 +339,24 @@ def __init__(self):
329339
with v3.Template(v_slot_append="True"):
330340
v3.VHotkey(keys="6", variant="contained", inline=True)
331341

332-
Title("Simulation Files")
333-
334-
Paragraph(
335-
"""
336-
QuickView has been developed using EAM's history output on
337-
the physics grids (pg2 grids) written by EAMv2, v3, and an
338-
intermediate version towards v4 (EAMxx).
339-
Those sample output files can be found on Zenodo.
340-
"""
341-
)
342-
Paragraph(
343-
"""
344-
Developers and users of EAM often use tools like NCO and CDO
345-
or write their own scripts to calculate time averages and/or
346-
select a subset of variables from the original model output.
347-
For those use cases, we clarify below the features of the data
348-
format that QuickView expects in order to properly read and
349-
visualize the simulation data.
350-
"""
351-
)
352-
353-
Title("Connectivity Files")
354-
355-
Paragraph(
356-
"""
357-
The horizontal grids used by EAM are cubed spheres.
358-
Since these are unstructed grids, QuickView needs
359-
to know how to map data to the globe. Therefore,
360-
for each simulation data file, a "connectivity file"
361-
needs to be provided.
362-
"""
363-
)
342+
Title("Project Background")
364343

365-
Paragraph(
366-
"""
367-
In EAMv2, v3, and v4, most of the variables
368-
(physical quantities) are written out on a
369-
"physics grid" (also referred to as "physgrid",
370-
"FV grid", or "control volume mesh") described
371-
in Hannah et al. (2021). The naming convention
372-
for such grids is ne*pg2, with * being a number,
373-
e.g., 4, 30, 120, 256. Further details about EAM's
374-
cubed-sphere grids can be found in EAM's documention,
375-
for example in this overview and this description.
376-
"""
377-
)
378-
Paragraph(
379-
"""
380-
Future versions of QuickView will also support the
381-
cubed-sphere meshes used by EAM's dynamical core,
382-
i.e., the ne*np4 grids (also referred to as
383-
"native grids" or "GLL grids").
384-
"""
344+
Paragraph(f"""
345+
QuickView was collaboratively developed by
346+
{Link("Kitware", "https://www.kitware.com")} and
347+
{Link("Pacific Northwest National Laboratory", "https://www.pnnl.gov/")}
348+
using funding from the U.S. Department of Energy's SciDAC program
349+
through a partnership between
350+
the {Link("Advanced Scientific Computing Reaserch (ASCR)",
351+
"https://www.energy.gov/science/ascr/advanced-scientific-computing-research")} program and
352+
the {Link("Biological and Environmental Research (BER)",
353+
"https://www.energy.gov/science/ber/biological-and-environmental-research")} program.
354+
"""
385355
)
386356

387-
Title("Project Background")
388-
389-
Paragraph(
390-
"""
391-
The lead developer of EAM QuickView is Abhishek Yenpure (abhi.yenpure@kitware.com)
392-
at Kitware, Inc.. Other key contributors at Kitware, Inc. include Berk Geveci and
393-
Sebastien Jourdain. Key contributors on the atmospheric science side are Hui Wan
394-
and Kai Zhang at Pacific Northwest National Laboratory.
395-
"""
357+
Paragraph(f"""
358+
The development of QuickView used resources of the
359+
{Link("National Energy Research Scientific Computing Center (NERSC)","https://www.nersc.gov/")},
360+
a U.S. Department of Energy User Facility.
361+
"""
396362
)

0 commit comments

Comments
 (0)