From d679a7c156c7ec14d5d72a96f9e6c1136142e9aa Mon Sep 17 00:00:00 2001 From: Eric Engle Date: Tue, 9 Jan 2024 12:02:58 -0500 Subject: [PATCH] Update docs. [skip ci] --- docs/grib2io.html | 190 ++++++++++++++---- docs/grib2io/tables.html | 2 +- docs/grib2io/tables/originating_centers.html | 2 +- docs/grib2io/tables/section0.html | 2 +- docs/grib2io/tables/section1.html | 2 +- docs/grib2io/tables/section3.html | 2 +- docs/grib2io/tables/section4.html | 2 +- docs/grib2io/tables/section4_discipline0.html | 2 +- docs/grib2io/tables/section4_discipline1.html | 2 +- .../grib2io/tables/section4_discipline10.html | 2 +- docs/grib2io/tables/section4_discipline2.html | 2 +- .../grib2io/tables/section4_discipline20.html | 2 +- docs/grib2io/tables/section4_discipline3.html | 2 +- docs/grib2io/tables/section4_discipline4.html | 2 +- docs/grib2io/tables/section5.html | 2 +- docs/grib2io/tables/section6.html | 2 +- 16 files changed, 165 insertions(+), 55 deletions(-) diff --git a/docs/grib2io.html b/docs/grib2io.html index aeb1336..d832212 100644 --- a/docs/grib2io.html +++ b/docs/grib2io.html @@ -3,7 +3,7 @@ - + grib2io API documentation @@ -2895,104 +2895,168 @@

Returns

-
+ +
gdtn - + +
- + 
685    @property
+686    def gdtn(self):
+687        """Return Grid Definition Template Number"""
+688        return self.section3[4]
+
+ +

Return Grid Definition Template Number

-
+ +
gdt - + +
- + 
691    @property
+692    def gdt(self):
+693        """Return Grid Definition Template"""
+694        return self.gridDefinitionTemplate
+
+ +

Return Grid Definition Template

-
+ +
pdtn - + +
- + 
697    @property
+698    def pdtn(self):
+699        """Return Product Definition Template Number"""
+700        return self.section4[1]
+
+ +

Return Product Definition Template Number

-
+ +
pdt - + +
- + 
703    @property
+704    def pdt(self):
+705        """Return Product Definition Template"""
+706        return self.productDefinitionTemplate
+
+ +

Return Product Definition Template

-
+ +
drtn - + +
- + 
709    @property
+710    def drtn(self):
+711        """Return Data Representation Template Number"""
+712        return self.section5[1]
+
+ +

Return Data Representation Template Number

-
+ +
drt - + +
- + 
715    @property
+716    def drt(self):
+717        """Return Data Representation Template"""
+718        return self.dataRepresentationTemplate
+
+ +

Return Data Representation Template

-
+ +
pdy - + +
- + 
721    @property
+722    def pdy(self):
+723        """Return the PDY ('YYYYMMDD')"""
+724        return ''.join([str(i) for i in self.section1[5:8]])
+
+ +

Return the PDY ('YYYYMMDD')

-
+ +
griddef - + +
- + 
727    @property
+728    def griddef(self):
+729        """Return a Grib2GridDef instance for a GRIB2 message"""
+730        return Grib2GridDef.from_section3(self.section3)
+
+ +

Return a Grib2GridDef instance for a GRIB2 message

@@ -3155,13 +3219,31 @@

Returns

-
+ +
data: <built-in function array> - + +
- + 
863    @property
+864    def data(self) -> np.array:
+865        """
+866        Accessing the data attribute loads data into memmory
+867        """
+868        if not hasattr(self,'_auto_nans'): self._auto_nans = _AUTO_NANS
+869        if hasattr(self,'_data'):
+870            if self._auto_nans != _AUTO_NANS:
+871                self._data = self._ondiskarray
+872            if isinstance(self._data, Grib2MessageOnDiskArray):
+873                self._ondiskarray = self._data
+874                self._data = np.asarray(self._data)
+875            return self._data
+876        raise ValueError
+
+ +

Accessing the data attribute loads data into memmory

@@ -4199,46 +4281,74 @@

Returns

-
+ +
nx - + +
- + 
1574    @property
+1575    def nx(self):
+1576        return self.gdt[7]
+
+ +
-
+ +
ny - + +
- + 
1578    @property
+1579    def ny(self):
+1580        return self.gdt[8]
+
+ +
-
+ +
npoints - + +
- + 
1582    @property
+1583    def npoints(self):
+1584        return self.gdt[7] * self.gdt[8]
+
+ +
-
+ +
shape - + +
- + 
1586    @property
+1587    def shape(self):
+1588        return (self.ny, self.nx)
+
+ +
diff --git a/docs/grib2io/tables.html b/docs/grib2io/tables.html index e0bea58..407041c 100644 --- a/docs/grib2io/tables.html +++ b/docs/grib2io/tables.html @@ -3,7 +3,7 @@ - + grib2io.tables API documentation diff --git a/docs/grib2io/tables/originating_centers.html b/docs/grib2io/tables/originating_centers.html index 65b4814..897a39b 100644 --- a/docs/grib2io/tables/originating_centers.html +++ b/docs/grib2io/tables/originating_centers.html @@ -3,7 +3,7 @@ - + grib2io.tables.originating_centers API documentation diff --git a/docs/grib2io/tables/section0.html b/docs/grib2io/tables/section0.html index fbb5179..2eb0dc7 100644 --- a/docs/grib2io/tables/section0.html +++ b/docs/grib2io/tables/section0.html @@ -3,7 +3,7 @@ - + grib2io.tables.section0 API documentation diff --git a/docs/grib2io/tables/section1.html b/docs/grib2io/tables/section1.html index b1ce72f..924e608 100644 --- a/docs/grib2io/tables/section1.html +++ b/docs/grib2io/tables/section1.html @@ -3,7 +3,7 @@ - + grib2io.tables.section1 API documentation diff --git a/docs/grib2io/tables/section3.html b/docs/grib2io/tables/section3.html index 7a022fa..7dbf6df 100644 --- a/docs/grib2io/tables/section3.html +++ b/docs/grib2io/tables/section3.html @@ -3,7 +3,7 @@ - + grib2io.tables.section3 API documentation diff --git a/docs/grib2io/tables/section4.html b/docs/grib2io/tables/section4.html index 71fcb7a..04c06d2 100644 --- a/docs/grib2io/tables/section4.html +++ b/docs/grib2io/tables/section4.html @@ -3,7 +3,7 @@ - + grib2io.tables.section4 API documentation diff --git a/docs/grib2io/tables/section4_discipline0.html b/docs/grib2io/tables/section4_discipline0.html index 668c344..c805722 100644 --- a/docs/grib2io/tables/section4_discipline0.html +++ b/docs/grib2io/tables/section4_discipline0.html @@ -3,7 +3,7 @@ - + grib2io.tables.section4_discipline0 API documentation diff --git a/docs/grib2io/tables/section4_discipline1.html b/docs/grib2io/tables/section4_discipline1.html index 72ddc4e..2f7b12a 100644 --- a/docs/grib2io/tables/section4_discipline1.html +++ b/docs/grib2io/tables/section4_discipline1.html @@ -3,7 +3,7 @@ - + grib2io.tables.section4_discipline1 API documentation diff --git a/docs/grib2io/tables/section4_discipline10.html b/docs/grib2io/tables/section4_discipline10.html index fbc70d5..5db727c 100644 --- a/docs/grib2io/tables/section4_discipline10.html +++ b/docs/grib2io/tables/section4_discipline10.html @@ -3,7 +3,7 @@ - + grib2io.tables.section4_discipline10 API documentation diff --git a/docs/grib2io/tables/section4_discipline2.html b/docs/grib2io/tables/section4_discipline2.html index 7f72928..db43f1a 100644 --- a/docs/grib2io/tables/section4_discipline2.html +++ b/docs/grib2io/tables/section4_discipline2.html @@ -3,7 +3,7 @@ - + grib2io.tables.section4_discipline2 API documentation diff --git a/docs/grib2io/tables/section4_discipline20.html b/docs/grib2io/tables/section4_discipline20.html index 643b953..ad67e47 100644 --- a/docs/grib2io/tables/section4_discipline20.html +++ b/docs/grib2io/tables/section4_discipline20.html @@ -3,7 +3,7 @@ - + grib2io.tables.section4_discipline20 API documentation diff --git a/docs/grib2io/tables/section4_discipline3.html b/docs/grib2io/tables/section4_discipline3.html index e4177ca..657ef3e 100644 --- a/docs/grib2io/tables/section4_discipline3.html +++ b/docs/grib2io/tables/section4_discipline3.html @@ -3,7 +3,7 @@ - + grib2io.tables.section4_discipline3 API documentation diff --git a/docs/grib2io/tables/section4_discipline4.html b/docs/grib2io/tables/section4_discipline4.html index 2b0dd35..70e2311 100644 --- a/docs/grib2io/tables/section4_discipline4.html +++ b/docs/grib2io/tables/section4_discipline4.html @@ -3,7 +3,7 @@ - + grib2io.tables.section4_discipline4 API documentation diff --git a/docs/grib2io/tables/section5.html b/docs/grib2io/tables/section5.html index dd48f0f..498b766 100644 --- a/docs/grib2io/tables/section5.html +++ b/docs/grib2io/tables/section5.html @@ -3,7 +3,7 @@ - + grib2io.tables.section5 API documentation diff --git a/docs/grib2io/tables/section6.html b/docs/grib2io/tables/section6.html index 2c86528..18e413f 100644 --- a/docs/grib2io/tables/section6.html +++ b/docs/grib2io/tables/section6.html @@ -3,7 +3,7 @@ - + grib2io.tables.section6 API documentation