Skip to content

Docs: update description & preview image of cf-plot gallery #901

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.

Sign up for GitHub

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

Merged
sadielbartholomew merged 4 commits into from
Oct 22, 2025
Merged

Docs: update description & preview image of cf-plot gallery #901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5860968
Add new cf-plot highlight gallery view & link to it in README
sadielbartholomew Oct 22, 2025
d35a619
Update cf-plot gallery images where ref'd in docs (intro & tutorial)
sadielbartholomew Oct 22, 2025
fcb06aa
Update cf-plot gallery description where ref'd in docs
sadielbartholomew Oct 22, 2025
c3f6195
Re-build docs to commit updated intro & tutorial HTML
sadielbartholomew Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ possible, are available with the [cf-plot
package](https://ncas-cms.github.io/cf-plot), which needs to be
installed separately to the `cf` package.

![Example outputs of cf-plot displaying selected aspects of `cf` field constructs](https://raw.githubusercontent.com/NCAS-CMS/cf-plot/master/docs/source/images/cf_gallery_image.png)
![Example outputs of cf-plot displaying selected aspects of `cf` field constructs](docs/source/images/new_gallery_view.png)

Command line utilities
======================
Expand Down
32 changes: 16 additions & 16 deletions docs/introduction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Introduction &#8212; Documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b3523f8e" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=541523b4" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=61cd365c" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=a5d0ad34" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=ca3c1c84" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=e5fbc548" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/customise-alabaster.css?v=5dec66a6" />
<script src="_static/documentation_options.js?v=5318ce95"></script>
Expand All @@ -29,16 +29,17 @@

<link rel="stylesheet" href="_static/custom.css" type="text/css" />




<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>
<div class="document">

<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.svg" alt="Logo of Python cf package"/>
<img class="logo" src="_static/logo.svg" alt="Logo"/>
</a></p>


Expand Down Expand Up @@ -213,12 +214,12 @@ <h2><a class="toc-backref" href="#id6" role="doc-backlink"><strong>Visualisation
constructs are available with the <code class="xref py py-obj docutils literal notranslate"><span class="pre">cf-plot</span></code> package that is installed
separately to <code class="xref py py-obj docutils literal notranslate"><span class="pre">cf</span></code> (see the
<a class="reference external" href="https://ncas-cms.github.io/cf-plot/build/">cf-plot documentation</a> for details).</p>
<p>See the <a class="reference external" href="https://ncas-cms.github.io/cf-plot/build/gallery.html">cf-plot gallery</a> for the wide range
<p>See the <a class="reference external" href="https://ncas-cms.github.io/cf-plot/gallery_of_examples.html">cf-plot gallery</a> for the wide range
of plotting possibilities with example code.</p>
<figure class="align-default" id="id3">
<img alt="_images/cfplot_example.png" src="_images/cfplot_example.png" />
<img alt="_images/new_gallery_view.png" src="_images/new_gallery_view.png" />
<figcaption>
<p><span class="caption-text"><em>Example output of cf-plot displaying a cf field construct.</em></span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
<p><span class="caption-text"><em>Examples gallery of plots made with the cf-plot library.</em></span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
</figcaption>
</figure>
</section>
Expand Down Expand Up @@ -312,8 +313,7 @@ <h2><a class="toc-backref" href="#id8" role="doc-backlink"><strong>Command line
<div class="line"><br /></div>
</div>
<figure class="align-default" id="id4">
<img alt="_images/cfdm_field.svg" src="_images/cfdm_field.svg" />
<figcaption>
<img alt="_images/cfdm_field.svg" src="_images/cfdm_field.svg" /><figcaption>
<p><span class="caption-text"><em>The constructs of the CF data model described using UML. The field construct corresponds to a CF-netCDF data variable. The domain construct provides the linkage between the field construct and the constructs which describe measurement locations and cell properties. It is useful to define an abstract generic coordinate construct that can be used to refer to coordinates when the their type (dimension or auxiliary coordinate construct) is not an issue.</em></span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
</figcaption>
</figure>
Expand Down Expand Up @@ -355,11 +355,11 @@ <h2><a class="toc-backref" href="#id10" role="doc-backlink"><strong>References</
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2025, NCAS | Page built on 2025-10-16.
&#169;2025, NCAS | Page built on 2025-10-22.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.4.7</a>
&amp; <a href="https://github.com/sphinx-doc/alabaster">Alabaster 0.7.14</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>

</div>

Expand Down
Binary file added docs/source/images/new_gallery_view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/source/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,12 +139,12 @@ separately to `cf` (see the
<https://ncas-cms.github.io/cf-plot/build/>`_ for details).

See the `cf-plot gallery
<https://ncas-cms.github.io/cf-plot/build/gallery.html>`_ for the wide range
<https://ncas-cms.github.io/cf-plot/gallery_of_examples.html>`_ for the wide range
of plotting possibilities with example code.

.. figure:: images/cfplot_example.png
.. figure:: images/new_gallery_view.png

*Example output of cf-plot displaying a cf field construct.*
*Examples gallery of plots made with the cf-plot library.*

----

Expand Down
6 changes: 3 additions & 3 deletions docs/source/tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,12 +547,12 @@ constructs are available with the `cf-plot` package (that needs to be
installed separately to cf, see `cf-plot documentation
<https://ncas-cms.github.io/cf-plot/build/>`_ for details).

.. figure:: images/cfplot_example.png
.. figure:: images/new_gallery_view.png

*Example output of cf-plot displaying a cf field construct.*
*Examples gallery of plots made with the cf-plot library.*

See the `cf-plot gallery
<https://ncas-cms.github.io/cf-plot/build/gallery.html>`_ for the wide
<https://ncas-cms.github.io/cf-plot/gallery_of_examples.html>`_ for the wide
range of plotting possibilities, with example code. These include, but are
not limited to:

Expand Down
35 changes: 18 additions & 17 deletions docs/tutorial.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Tutorial &#8212; Documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b3523f8e" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=541523b4" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=61cd365c" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=a5d0ad34" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=ca3c1c84" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=e5fbc548" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/customise-alabaster.css?v=5dec66a6" />
<script src="_static/documentation_options.js?v=5318ce95"></script>
Expand All @@ -30,16 +30,17 @@

<link rel="stylesheet" href="_static/custom.css" type="text/css" />




<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>
<div class="document">

<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/logo.svg" alt="Logo of Python cf package"/>
<img class="logo" src="_static/logo.svg" alt="Logo"/>
</a></p>


Expand Down Expand Up @@ -128,8 +129,8 @@ <h3>Related Topics</h3>
<hr class="docutils" />
<p>Version 3.18.2 for version 1.12 of the CF conventions.</p>
<p>All of the Python code in this tutorial is available in two executable
scripts (<a class="reference download internal" download="" href="_downloads/bb5fb8d8c9c79615a69f3b221f87dfa4/tutorial.py"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>, 28kB,
<a class="reference download internal" download="" href="_downloads/f005a212533d023d9ca8ee5ecd9a9065/field_analysis.py"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>, 8kB).</p>
scripts (<a class="reference download internal" download="" href="_downloads/tutorial.py"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>, 28kB,
<a class="reference download internal" download="" href="_downloads/field_analysis.py"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>, 8kB).</p>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#sample-datasets" id="id387"><strong>Sample datasets</strong></a></p></li>
Expand Down Expand Up @@ -359,7 +360,7 @@ <h3>Related Topics</h3>
<span id="id2"></span><h2><a class="toc-backref" href="#id387" role="doc-backlink"><strong>Sample datasets</strong></a><a class="headerlink" href="#sample-datasets" title="Link to this heading">¶</a></h2>
<p>This tutorial uses a number of small sample datasets, all of which can
be found in the zip file <code class="docutils literal notranslate"><span class="pre">cf_tutorial_files.zip</span></code>
(<a class="reference download internal" download="" href="_downloads/662a6146f847a4d1c19d523d3f30e1cc/cf_tutorial_files.zip"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>,
(<a class="reference download internal" download="" href="_downloads/cf_tutorial_files.zip"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>,
164kB):</p>
<div class="literal-block-wrapper docutils container" id="id120">
<div class="code-block-caption"><span class="caption-text"><em>Unpack the sample datasets.</em></span><a class="headerlink" href="#id120" title="Link to this code">¶</a></div>
Expand Down Expand Up @@ -853,12 +854,12 @@ <h2><a class="toc-backref" href="#id398" role="doc-backlink"><strong>Visualisati
constructs are available with the <code class="xref py py-obj docutils literal notranslate"><span class="pre">cf-plot</span></code> package (that needs to be
installed separately to cf, see <a class="reference external" href="https://ncas-cms.github.io/cf-plot/build/">cf-plot documentation</a> for details).</p>
<figure class="align-default" id="id131">
<img alt="_images/cfplot_example.png" src="_images/cfplot_example.png" />
<img alt="_images/new_gallery_view.png" src="_images/new_gallery_view.png" />
<figcaption>
<p><span class="caption-text"><em>Example output of cf-plot displaying a cf field construct.</em></span><a class="headerlink" href="#id131" title="Link to this image">¶</a></p>
<p><span class="caption-text"><em>Examples gallery of plots made with the cf-plot library.</em></span><a class="headerlink" href="#id131" title="Link to this image">¶</a></p>
</figcaption>
</figure>
<p>See the <a class="reference external" href="https://ncas-cms.github.io/cf-plot/build/gallery.html">cf-plot gallery</a> for the wide
<p>See the <a class="reference external" href="https://ncas-cms.github.io/cf-plot/gallery_of_examples.html">cf-plot gallery</a> for the wide
range of plotting possibilities, with example code. These include, but are
not limited to:</p>
<ul class="simple">
Expand Down Expand Up @@ -10107,11 +10108,11 @@ <h3><a class="toc-backref" href="#id514" role="doc-backlink">Curl</a><a class="h
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2025, NCAS | Page built on 2025-10-16.
&#169;2025, NCAS | Page built on 2025-10-22.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.4.7</a>
&amp; <a href="https://github.com/sphinx-doc/alabaster">Alabaster 0.7.14</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>

</div>

Expand Down
Loading