From 72e88ec421647844bb9fd9ed3ebffdc38e4f0a8b Mon Sep 17 00:00:00 2001 From: Martin Yeo Date: Wed, 12 Jun 2024 18:44:52 +0100 Subject: [PATCH 1/8] README suggestions. --- README.md | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index b9b33802..abefe478 100644 --- a/README.md +++ b/README.md @@ -40,22 +40,19 @@ et al, which specialise in preparing your spatial data for visualisation. Rather choice of tool to you the user, as we want GeoVista to remain as flexible and open-ended as possible to the entire Scientific Python community. -Simply put, "*GeoVista is to PyVista*", as "*Cartopy is to Matplotlib*". Well, that's the aspiration. +Simply put, "*GeoVista is to PyVista*", as "*[Cartopy](https://scitools.org.uk/cartopy/docs/latest/) is to +[Matplotlib](https://matplotlib.org/stable/index.html)*". Well, that's the aspiration. ## Installation GeoVista is available on both [conda-forge](https://anaconda.org/conda-forge/geovista) and [PyPI](https://pypi.org/project/geovista/). -We recommend using [mamba](https://github.com/mamba-org/mamba) to install GeoVista 👍 +We recommend using [conda](https://docs.conda.io/projects/conda/en/latest/index.html) to install GeoVista 👍 -### Mamba +### Conda GeoVista is available on [conda-forge](https://anaconda.org/conda-forge/geovista), and can be easily installed with -[mamba](https://github.com/mamba-org/mamba): -```shell -mamba install -c conda-forge geovista -``` -or alternatively with [conda](https://docs.conda.io/projects/conda/en/latest/index.html): +[conda](https://docs.conda.io/projects/conda/en/latest/index.html): ```shell conda install -c conda-forge geovista ``` @@ -90,7 +87,7 @@ cd geovista ``` Create the `geovista-dev` conda development environment: ```shell -mamba env create --file requirements/geovista.yml +conda env create --file requirements/geovista.yml ``` Now activate the environment and install the `main` development branch of GeoVista: ```shell @@ -170,13 +167,13 @@ plotter.show() ``` -![ww3-tri](https://raw.githubusercontent.com/bjlittle/geovista-media/2023.09.1/media/readme/ww3-tri.png) +

#### Finite Volume Community Ocean Model Now, let's visualise the bathymetry of the [Plymouth Sound and Tamar River](https://www.google.com/maps/place/Plymouth+Sound/@50.3337382,-4.2215988,12z/data=!4m5!3m4!1s0x486c93516bbce307:0xded7654eaf4f8f83!8m2!3d50.3638359!4d-4.1441365) -from an [FVCOM](http://fvcom.smast.umassd.edu/fvcom/) **unstructured** mesh, as kindly provided by the +from an [FVCOM](https://www.fvcom.org/) **unstructured** mesh, as kindly provided by the [Plymouth Marine Laboratory](https://pml.ac.uk/) using the lush [cmocean deep](https://matplotlib.org/cmocean/#deep) colormap.
@@ -213,7 +210,7 @@ plotter.show() ```
-![tamar](https://raw.githubusercontent.com/bjlittle/geovista-media/2023.09.1/media/readme/tamar.png) +

#### CF UGRID @@ -262,7 +259,7 @@ plotter.show() ``` -![lam-mollweide](https://raw.githubusercontent.com/bjlittle/geovista-media/2023.09.1/media/readme/lam-moll.png) +

Using the same **unstructured** LAM data, reproject to [Equidistant Cylindrical](https://proj.org/operations/projections/eqc.html) but this time using a @@ -306,7 +303,7 @@ plotter.show() ``` -![lam-mollweide](https://raw.githubusercontent.com/bjlittle/geovista-media/2023.09.1/media/readme/lam-eqc.png) +

#### LFRic Cube-Sphere @@ -346,7 +343,7 @@ plotter.show() ``` -![lam-mollweide](https://raw.githubusercontent.com/bjlittle/geovista-media/2023.09.1/media/readme/lfric-robin.png) +

#### UM ORCA2 @@ -384,7 +381,7 @@ plotter.show() ``` -![um-orca](https://raw.githubusercontent.com/bjlittle/geovista-media/2023.09.1/media/readme/um-orca.png) +

#### OISST AVHRR @@ -422,7 +419,7 @@ plotter.show() ``` -![oisst-avhrr](https://raw.githubusercontent.com/bjlittle/geovista-media/2023.09.1/media/readme/oisst-avhrr.png) +

#### DYNAMICO @@ -457,7 +454,7 @@ plotter.show() ``` -![dynamico-icosahedral](https://raw.githubusercontent.com/bjlittle/geovista-media/2023.09.1/media/readme/dynamico-icosahedral.png) +

## Unreal Reels From e84f52c883d05bad1fd1d07f702b51495a686231 Mon Sep 17 00:00:00 2001 From: Martin Yeo Date: Wed, 12 Jun 2024 18:56:34 +0100 Subject: [PATCH 2/8] README refactor pantry. --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index abefe478..6e4b4cc1 100644 --- a/README.md +++ b/README.md @@ -139,11 +139,11 @@ base layer, and the gorgeous perceptually uniform [cmocean balance](https://matp colormap.
-🗒 +🗒 click for code ```python import geovista as gv -from geovista.pantry import ww3_global_tri +from geovista.pantry.data import ww3_global_tri import geovista.theme # Load the sample data. @@ -177,11 +177,11 @@ from an [FVCOM](https://www.fvcom.org/) **unstructured** mesh, as kindly provide [Plymouth Marine Laboratory](https://pml.ac.uk/) using the lush [cmocean deep](https://matplotlib.org/cmocean/#deep) colormap.
-🗒 +🗒 click for code ```python import geovista as gv -from geovista.pantry import fvcom_tamar +from geovista.pantry.data import fvcom_tamar import geovista.theme # Load the sample data. @@ -228,11 +228,11 @@ In the meantime, let's showcase our basic projection support with some high-reso base layer.
-🗒 +🗒 click for code ```python import geovista as gv -from geovista.pantry import lam_pacific +from geovista.pantry.data import lam_pacific import geovista.theme # Load the sample data. @@ -270,13 +270,13 @@ and a base layer.
-🗒 +🗒 click for code ```python import cartopy.crs as ccrs import geovista as gv -from geovista.pantry import lam_pacific +from geovista.pantry.data import lam_pacific import geovista.theme # Load the sample data. @@ -314,11 +314,11 @@ Now render a [Met Office LFRic](https://www.metoffice.gov.uk/research/approach/m [cmocean thermal](https://matplotlib.org/cmocean/#thermal) colormap.
-🗒 +🗒 click for code ```python import geovista as gv -from geovista.pantry import lfric_sst +from geovista.pantry.data import lfric_sst import geovista.theme # Load the sample data. @@ -353,11 +353,11 @@ using Met Office Unified Model (UM) ORCA2 Sea Water Potential Temperature data, [1:50m Natural Earth I](https://www.naturalearthdata.com/downloads/50m-raster-data/50m-natural-earth-1/) base layer.
-🗒 +🗒 click for code ```python import geovista as gv -from geovista.pantry import um_orca2 +from geovista.pantry.data import um_orca2 import geovista.theme # Load sample data. @@ -391,11 +391,11 @@ Now let's render a [NOAA/NCEI Optimum Interpolation SST](https://www.ncei.noaa.g [NASA Blue Marble](https://visibleearth.nasa.gov/collection/1484/blue-marble) base layer.
-🗒 +🗒 click for code ```python import geovista as gv -from geovista.pantry import oisst_avhrr_sst +from geovista.pantry.data import oisst_avhrr_sst import geovista.theme # Load sample data. @@ -431,11 +431,11 @@ model uses hexagonal and pentagonal cells, and is a new dynamical core for [10m Natural Earth coastlines](https://www.naturalearthdata.com/downloads/10m-physical-vectors/10m-coastline/).
-🗒 +🗒 click for code ```python import geovista as gv -from geovista.pantry import dynamico +from geovista.pantry.data import dynamico import geovista.theme # Load sample data. From b5828d64592e1a7b0069eeb589b5f5f618468399 Mon Sep 17 00:00:00 2001 From: Martin Yeo Date: Wed, 12 Jun 2024 19:29:15 +0100 Subject: [PATCH 3/8] More README suggestions. --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 6e4b4cc1..8f6378c8 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,11 @@ | 🛡️ Status | [![scitools](https://img.shields.io/badge/scitools-ownership%20pending-yellow)](https://github.com/bjlittle/geovista/issues/167) | | | | +

+ +
+Less than 20 lines of Python! +

## Motivation From 7f23fa23dab285b6ee50a1850f0e25082812d4eb Mon Sep 17 00:00:00 2001 From: Martin Yeo Date: Fri, 14 Jun 2024 13:33:53 +0100 Subject: [PATCH 4/8] Revert "README refactor pantry." This reverts commit e84f52c883d05bad1fd1d07f702b51495a686231. --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 8f6378c8..b0ce4de6 100644 --- a/README.md +++ b/README.md @@ -144,11 +144,11 @@ base layer, and the gorgeous perceptually uniform [cmocean balance](https://matp colormap.
-🗒 click for code +🗒 ```python import geovista as gv -from geovista.pantry.data import ww3_global_tri +from geovista.pantry import ww3_global_tri import geovista.theme # Load the sample data. @@ -182,11 +182,11 @@ from an [FVCOM](https://www.fvcom.org/) **unstructured** mesh, as kindly provide [Plymouth Marine Laboratory](https://pml.ac.uk/) using the lush [cmocean deep](https://matplotlib.org/cmocean/#deep) colormap.
-🗒 click for code +🗒 ```python import geovista as gv -from geovista.pantry.data import fvcom_tamar +from geovista.pantry import fvcom_tamar import geovista.theme # Load the sample data. @@ -233,11 +233,11 @@ In the meantime, let's showcase our basic projection support with some high-reso base layer.
-🗒 click for code +🗒 ```python import geovista as gv -from geovista.pantry.data import lam_pacific +from geovista.pantry import lam_pacific import geovista.theme # Load the sample data. @@ -275,13 +275,13 @@ and a base layer.
-🗒 click for code +🗒 ```python import cartopy.crs as ccrs import geovista as gv -from geovista.pantry.data import lam_pacific +from geovista.pantry import lam_pacific import geovista.theme # Load the sample data. @@ -319,11 +319,11 @@ Now render a [Met Office LFRic](https://www.metoffice.gov.uk/research/approach/m [cmocean thermal](https://matplotlib.org/cmocean/#thermal) colormap.
-🗒 click for code +🗒 ```python import geovista as gv -from geovista.pantry.data import lfric_sst +from geovista.pantry import lfric_sst import geovista.theme # Load the sample data. @@ -358,11 +358,11 @@ using Met Office Unified Model (UM) ORCA2 Sea Water Potential Temperature data, [1:50m Natural Earth I](https://www.naturalearthdata.com/downloads/50m-raster-data/50m-natural-earth-1/) base layer.
-🗒 click for code +🗒 ```python import geovista as gv -from geovista.pantry.data import um_orca2 +from geovista.pantry import um_orca2 import geovista.theme # Load sample data. @@ -396,11 +396,11 @@ Now let's render a [NOAA/NCEI Optimum Interpolation SST](https://www.ncei.noaa.g [NASA Blue Marble](https://visibleearth.nasa.gov/collection/1484/blue-marble) base layer.
-🗒 click for code +🗒 ```python import geovista as gv -from geovista.pantry.data import oisst_avhrr_sst +from geovista.pantry import oisst_avhrr_sst import geovista.theme # Load sample data. @@ -436,11 +436,11 @@ model uses hexagonal and pentagonal cells, and is a new dynamical core for [10m Natural Earth coastlines](https://www.naturalearthdata.com/downloads/10m-physical-vectors/10m-coastline/).
-🗒 click for code +🗒 ```python import geovista as gv -from geovista.pantry.data import dynamico +from geovista.pantry import dynamico import geovista.theme # Load sample data. From c25039012f25af334d959367186072e7d5b2debd Mon Sep 17 00:00:00 2001 From: Martin Yeo Date: Fri, 14 Jun 2024 13:34:51 +0100 Subject: [PATCH 5/8] Restore click for code hint. --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b0ce4de6..b15b5e45 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,7 @@ base layer, and the gorgeous perceptually uniform [cmocean balance](https://matp colormap.
-🗒 +🗒 click for code ```python import geovista as gv @@ -182,7 +182,7 @@ from an [FVCOM](https://www.fvcom.org/) **unstructured** mesh, as kindly provide [Plymouth Marine Laboratory](https://pml.ac.uk/) using the lush [cmocean deep](https://matplotlib.org/cmocean/#deep) colormap.
-🗒 +🗒 click for code ```python import geovista as gv @@ -233,7 +233,7 @@ In the meantime, let's showcase our basic projection support with some high-reso base layer.
-🗒 +🗒 click for code ```python import geovista as gv @@ -275,7 +275,7 @@ and a base layer.
-🗒 +🗒 click for code ```python import cartopy.crs as ccrs @@ -319,7 +319,7 @@ Now render a [Met Office LFRic](https://www.metoffice.gov.uk/research/approach/m [cmocean thermal](https://matplotlib.org/cmocean/#thermal) colormap.
-🗒 +🗒 click for code ```python import geovista as gv @@ -358,7 +358,7 @@ using Met Office Unified Model (UM) ORCA2 Sea Water Potential Temperature data, [1:50m Natural Earth I](https://www.naturalearthdata.com/downloads/50m-raster-data/50m-natural-earth-1/) base layer.
-🗒 +🗒 click for code ```python import geovista as gv @@ -396,7 +396,7 @@ Now let's render a [NOAA/NCEI Optimum Interpolation SST](https://www.ncei.noaa.g [NASA Blue Marble](https://visibleearth.nasa.gov/collection/1484/blue-marble) base layer.
-🗒 +🗒 click for code ```python import geovista as gv @@ -436,7 +436,7 @@ model uses hexagonal and pentagonal cells, and is a new dynamical core for [10m Natural Earth coastlines](https://www.naturalearthdata.com/downloads/10m-physical-vectors/10m-coastline/).
-🗒 +🗒 click for code ```python import geovista as gv From 1abe1eb6d0a4ef9b8b26d6f3df401d8631186ac0 Mon Sep 17 00:00:00 2001 From: Martin Yeo Date: Fri, 14 Jun 2024 13:47:55 +0100 Subject: [PATCH 6/8] Better shop window. --- README.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index b15b5e45..ef78d42b 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,24 @@

Cartographic rendering and mesh analytics powered by PyVista + + 😍 Bring your data to life! 😍

+[🎥 WW3 SMC time-series](https://github.com/bjlittle/geovista/assets/2051656/876d877e-a6fa-42ff-8153-08c41ff8a19e) + +
What is this? + +GeoVista is built on the shoulders of giants, namely [PyVista](https://docs.pyvista.org/version/stable/) and +[VTK](https://vtk.org/documentation/), thus allowing it to easily leverage the power of the GPU. + +As a result, it offers a paradigm shift in rendering performance and interactive user experience, as demonstrated by +this realtime, time-series animation of WAVEWATCH III® third-generation wave model (**WAVE**-height, **WAT**er depth +and **C**urrent **H**indcasting), developed at [NOAA](https://www.noaa.gov/)/[NCEP](https://www.weather.gov/ncep/), +quasi-unstructured Spherical Multi-Cell (SMC) grid data of Sea Surface Wave Significant Height located on cell faces. + +
+ | | | |--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -22,12 +38,6 @@ | 🛡️ Status | [![scitools](https://img.shields.io/badge/scitools-ownership%20pending-yellow)](https://github.com/bjlittle/geovista/issues/167) | | | | -

- -
-Less than 20 lines of Python! -

- ## Motivation The goal of GeoVista is simple; to complement [PyVista](https://docs.pyvista.org/index.html) with a convenient @@ -45,8 +55,10 @@ et al, which specialise in preparing your spatial data for visualisation. Rather choice of tool to you the user, as we want GeoVista to remain as flexible and open-ended as possible to the entire Scientific Python community. -Simply put, "*GeoVista is to PyVista*", as "*[Cartopy](https://scitools.org.uk/cartopy/docs/latest/) is to -[Matplotlib](https://matplotlib.org/stable/index.html)*". Well, that's the aspiration. +Simply put, "*[GeoVista](https://geovista.readthedocs.io/) is to +[PyVista](https://docs.pyvista.org/)*", as +"*[Cartopy](https://scitools.org.uk/cartopy/docs/latest/) is to +[Matplotlib](https://matplotlib.org/)*". Well, that's the aspiration. ## Installation @@ -461,18 +473,6 @@ plotter.show()

-## Unreal Reels - -GeoVista is built on the shoulders of giants, namely [PyVista](https://docs.pyvista.org/version/stable/) and -[VTK](https://vtk.org/documentation/), thus allowing it to easily leverage the power of the GPU. - -As a result, it offers a paradigm shift in rendering performance and interactive user experience, as demonstrated by -this realtime, time-series animation of WAVEWATCH III® third-generation wave model (**WAVE**-height, **WAT**er depth -and **C**urrent **H**indcasting), developed at [NOAA](https://www.noaa.gov/)/[NCEP](https://www.weather.gov/ncep/), -quasi-unstructured Spherical Multi-Cell (SMC) grid data of Sea Surface Wave Significant Height located on cell faces. - -[🎥 WW3 SMC time-series](https://github.com/bjlittle/geovista/assets/2051656/876d877e-a6fa-42ff-8153-08c41ff8a19e) - ## Further Examples

From 6fcfed9a42ac169a7e07f137a49dd4311aa5ffa1 Mon Sep 17 00:00:00 2001 From: Martin Yeo Date: Fri, 14 Jun 2024 13:53:06 +0100 Subject: [PATCH 7/8] Even better shop window. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ef78d42b..9842f5d1 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@

Cartographic rendering and mesh analytics powered by PyVista - - 😍 Bring your data to life! 😍 +
+ 😍 Bring your data to life! 😍

[🎥 WW3 SMC time-series](https://github.com/bjlittle/geovista/assets/2051656/876d877e-a6fa-42ff-8153-08c41ff8a19e) @@ -23,6 +23,8 @@ this realtime, time-series animation of WAVEWATCH III® third-generation wave mo and **C**urrent **H**indcasting), developed at [NOAA](https://www.noaa.gov/)/[NCEP](https://www.weather.gov/ncep/), quasi-unstructured Spherical Multi-Cell (SMC) grid data of Sea Surface Wave Significant Height located on cell faces. +Like what you see? Loads more information is available below, so keep on scrolling! 🚀 +
From 9d551ff3a799a7119a068c3f148c8868d0f7b564 Mon Sep 17 00:00:00 2001 From: Martin Yeo Date: Fri, 14 Jun 2024 13:55:11 +0100 Subject: [PATCH 8/8] Even better shop window. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9842f5d1..186b1b3b 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@

Cartographic rendering and mesh analytics powered by PyVista -
+

+ +

😍 Bring your data to life! 😍