Merge pull request #34 from sadielbartholomew/docs-building

Docs: clean build to update & purge superfluous JS etc.
NCAS-CMS · Mar 11, 2024 · 525d2fa · 525d2fa
2 parents 4eb2efa + 2eaeb97
commit 525d2fa
Show file tree

Hide file tree

Showing 57 changed files with 304 additions and 67,520 deletions.
diff --git a/cf_plot.egg-info/PKG-INFO b/cf_plot.egg-info/PKG-INFO
@@ -1,24 +1,101 @@
 Metadata-Version: 2.1
 Name: cf-plot
-Version: 3.1.6
+Version: 3.3.0
 Summary: Climate contour, vector and line plots in Python
 Home-page: http://ajheaps.github.io/cf-plot
 Author: Andy Heaps
 Author-email: andy.heaps@ncas.ac.uk
+Maintainer: Sadie Bartholomew
+Maintainer-email: sadie.bartholomew@ncas.ac.uk
 License: LICENSE.txt
-Description: =======
-        cf-plot
-        =======
-
-        cf-plot is a set of Python plotting routines for the contour, vector and line plots that climate
-        researchers commonly make.  
-
-
-        Documentation
-        =============
-        Please refer to the cf-plot homepage http://ajheaps.github.io/cf-plot
-
-
-
-Platform: UNKNOWN
 Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: matplotlib>=3.1.0
+Requires-Dist: cf-python>=3.9.0
+Requires-Dist: scipy>=1.4.0
+Requires-Dist: cartopy>=0.17.0
+
+# cf-plot
+
+## Code-light plotting for earth science and aligned research
+
+### Overview
+
+![cf-plot example gallery of plots](docs/source/images/cf_gallery_image.png "Examples Gallery of plots made with the cf-plot library")
+
+**cf-plot allows you to produce and customise publication-quality contour,
+vector, line and more plots with the power of Python,
+[matplotlib](https://matplotlib.org/),
+[Cartopy](https://scitools.org.uk/cartopy/docs/latest/) and
+[cf-python](https://ncas-cms.github.io/cf-python/), in as few lines of code
+as possible.**
+
+It is designed to be a useful visualisation tool for environmental, earth
+and aligned sciences, for example to facilitate climate and meteorological
+research. cf-plot is developed and maintained by the
+[NCAS-CMS](https://cms.ncas.ac.uk/index.html) group, part of
+[NCAS](https://ncas.ac.uk/).
+
+
+### Brief Demonstration
+
+In as little as four lines of Python including imports and file reading,
+using `cf-plot` you can for example produce a contour plot showing a 2D
+subspace of a netCDF dataset:
+
+```python
+import cf
+import cfplot as cfp
+f = cf.read('<dataset name>.nc')[0]  # picks out a read-in field of the dataset
+cfp.con(f.subspace(time=<chosen time value>))  # creates a contour plot of the field at that time value
+```
+
+
+### Examples Gallery
+
+A gallery of outputs made with cf-plot, showcasing a range of plotting
+possibilities with links to relevant documentation pages and to example code,
+can be found
+[on this dedicated page within the documentation](http://ajheaps.github.io/cf-plot/gallery.html),
+as illustrated in the (static) image at the top of this document.
+
+
+### Documentation
+
+See [the cf-plot homepage](http://ajheaps.github.io/cf-plot)
+(`http://ajheaps.github.io/cf-plot`) for the full online documentation.
+
+
+### Installation
+
+To install cf-plot with its required dependencies, you can use `pip`:
+
+```bash
+pip install cf-python cf-plot
+```
+
+or you can use `conda` (or similar package managers such
+as `mamba`) as follows (or equivalent):
+
+```bash
+conda install -c ncas -c conda-forge cf-python cf-plot udunits2
+```
+
+More detail about installation is provided on the
+[installation page](http://ajheaps.github.io/cf-plot/download.html)
+(`http://ajheaps.github.io/cf-plot/download.html`)
+of the documentation.
+
+### Contributing
+
+Everyone is welcome to contribute to cf-plot in the form
+of bug reports, documentation, code, design proposals, and more.
+
+Contributing guidelines will be added to the repository shortly.
+
+
+### Help: Issues, Questions, Feature Requests, etc.
+
+For any queries, see the
+[guidance page](http://ajheaps.github.io/cf-plot/issues.html)
+(`http://ajheaps.github.io/cf-plot/issues.html`).
diff --git a/cf_plot.egg-info/SOURCES.txt b/cf_plot.egg-info/SOURCES.txt
@@ -1,6 +1,6 @@
+LICENSE.txt
 MANIFEST.in
 README.md
-README.txt
 setup.py
 cf_plot.egg-info/PKG-INFO
 cf_plot.egg-info/SOURCES.txt

diff --git a/docs/build/.buildinfo b/docs/build/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0a739ebdc2d63ea1871255cde05d846d
+config: b20cddc9ac81d3adb3cbbbe7bfbc4417
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/_images/cm.png b/docs/build/_images/cm.png
diff --git a/docs/build/_images/data_fig1.png b/docs/build/_images/data_fig1.png
diff --git a/docs/build/_images/data_fig2.png b/docs/build/_images/data_fig2.png
diff --git a/docs/build/_images/data_fig3.png b/docs/build/_images/data_fig3.png
diff --git a/docs/build/_images/data_fig4.png b/docs/build/_images/data_fig4.png
diff --git a/docs/build/_images/data_fig5.png b/docs/build/_images/data_fig5.png
diff --git a/docs/build/_images/data_fig6.png b/docs/build/_images/data_fig6.png
diff --git a/docs/build/_images/fig24.png b/docs/build/_images/fig24.png
diff --git a/docs/build/_images/fig25.png b/docs/build/_images/fig25.png
diff --git a/docs/build/_images/fig26.png b/docs/build/_images/fig26.png
diff --git a/docs/build/_images/guide1.png b/docs/build/_images/guide1.png
diff --git a/docs/build/_images/guide2.png b/docs/build/_images/guide2.png
diff --git a/docs/build/_images/guide3.png b/docs/build/_images/guide3.png
diff --git a/docs/build/_images/guide4.png b/docs/build/_images/guide4.png
diff --git a/docs/build/_modules/cfplot.html b/docs/build/_modules/cfplot.html
diff --git a/docs/build/_modules/cfplot/cfplot.html b/docs/build/_modules/cfplot/cfplot.html
diff --git a/docs/build/_modules/index.html b/docs/build/_modules/index.html
diff --git a/docs/build/_sources/cfplot_colorbar.rst.txt b/docs/build/_sources/cfplot_colorbar.rst.txt