tsp 1.8.0__py3-none-any.whl → 1.8.1__py3-none-any.whl

tsp/__meta__.py

@@ -1,3 +1,3 @@
 # Automatically created. Please do not edit.
-__version__ = '1.8.0'
+__version__ = '1.8.1'
 __author__ = 'Nick Brown'

tsp/core.py

@@ -11,7 +11,7 @@ try:
     import netCDF4 as nc
 
     try:
-        from pfit.pfnet_standard import make_temperature_base
+        from pfit.pfnet_standard import make_temperature_base, calculate_extent_metadata as calc_ext_meta
     except ModuleNotFoundError:
         warnings.warn("Missing pfit library. Some functionality will be limited.", stacklevel=2)
 
@@ -121,14 +121,46 @@ class TSP:
         self.__number_of_observations = np.ones_like(values, dtype=int)
         self.__number_of_observations[np.isnan(values)] = 0
         self.metadata = metadata
-        self.latitude = latitude
-        self.longitude = longitude
+        self._latitude = latitude
+        self._longitude = longitude
         self.site_id = site_id
         self._freq = None
         self._completeness = None
 
         self._export_precision = 3
 
+    @property
+    def latitude(self):
+        """ Latitude at which data were collected """
+        return self._latitude
+    
+    @latitude.setter
+    def latitude(self, value: Optional[float]):
+        if value is not None:
+            try:
+                self._latitude = float(value)
+            except ValueError:
+                raise ValueError("Latitude must be a float or None.")
+        else:
+            self._latitude = None
+        self.metadata['_latitude'] = self._latitude
+
+    @property
+    def longitude(self):
+        """ Longitude at which data were collected """
+        return self._longitude
+
+    @longitude.setter
+    def longitude(self, value: Optional[float]):
+        if value is not None:
+            try:
+                self._longitude = float(value)
+            except ValueError:
+                raise ValueError("Longitude must be a float or None.")
+        else:
+            self._longitude = None
+        self.metadata['_longitude'] = self._longitude
+
     @property
     def freq(self) -> Optional[int]:
         """ Measurement frequency [s] """
@@ -648,7 +680,7 @@ class TSP:
         
         df.to_csv(filename, index=False, na_rep="-999")
 
-    def to_ntgs(self, filename:str, project_name:str="", site_id:"Optional[str]" = None, latitude:"Optional[float]"=None, longitude:"Optional[float]"=None) -> None:
+    def to_ntgs(self, filename:str, project_name:Optional[str]="", site_id:"Optional[str]" = None, latitude:"Optional[float]"=None, longitude:"Optional[float]"=None) -> None:
         """ Write the data in NTGS template format 
 
         Parameters
@@ -671,7 +703,11 @@ class TSP:
             longitude = self.longitude if self.longitude is not None else ""
 
         if site_id is None:
-                site_id = self.site_id if self.site_id is not None else ""
+            site_id = self.site_id if self.site_id is not None else ""
+
+        if project_name is None:
+            project_name = self.metadata.get("project_name", "")
+
         data = self.values
 
         df = pd.DataFrame({'project_name': pd.Series(dtype='str'),
@@ -695,10 +731,10 @@ class TSP:
 
         df.to_csv(filename, index=False)
 
-    def to_netcdf(self, file: str) -> None:
+    def to_netcdf(self, file: str, only_use_cf_metadata=True, calculate_extent_metadata=True) -> None:
         """  Write the data as a netcdf"""
         try:
-            ncf = make_temperature_base(file, len(self.depths))
+            ncf = make_temperature_base(file, ndepth=len(self.depths), ntime=len(self.times), strings_as_strings=True)
         except NameError:
             warnings.warn("Missing required packages. Try installing with `pip install tsp[nc]`", stacklevel=2)
             return
@@ -717,14 +753,32 @@ class TSP:
             if self.longitude:
                 ncd['longitude'][:] = self.longitude
             if self.site_id:
-                ncd['site_name'] = self.site_id
+                if ncd['site_name'].dtype == str:
+                    ncd['site_name'][0] = self.site_id
+                else:
+                    strlen = ncd['site_name'].shape[0]
+                    ncd['site_name'][:] = nc.stringtochar(np.array([self.site_id], f"S{strlen}"))
+
+            if "_elevation" in self.metadata:
+                ncd['surface_elevation'][:] = self.metadata.get("_elevation")
+            
+            if only_use_cf_metadata:
+                metadata = self.metadata.get('CF', {})
+            else:
+                metadata = self.metadata
             
-            for key, value in self.metadata:
+            for key, value in metadata.items():
                 try:
-                    ncd.setncattr(key, value)
+                    if isinstance(value, str):
+                        ncd.setncattr_string(key, value)
+                    else:
+                        ncd.setncattr(key, value)
                 except Exception:
-                    warnings.warn(f"Could not set metadata item: {key}", stacklevel=2)
+                    warnings.warn(f"Could not set metadata item: {key} : {value}", stacklevel=2)
 
+            if calculate_extent_metadata:
+                calc_ext_meta(ncd)
+                
     def to_json(self, file: str) -> None:
         """ Write the data to a serialized json file """
         with open(file, 'w') as f:

tsp/version.py

@@ -1 +1 @@
-version="1.8.0"
+version="1.8.1"

{tsp-1.8.0.dist-info → tsp-1.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tsp
-Version: 1.8.0
+Version: 1.8.1
 Summary: Making permafrost data effortless
 Home-page: https://gitlab.com/permafrostnet/teaspoon
 Author: Nick Brown
@@ -27,10 +27,10 @@ Provides-Extra: rbr
 Requires-Dist: pyrsktools; extra == "rbr"
 Requires-Dist: openpyxl; extra == "rbr"
 Provides-Extra: full
-Requires-Dist: netCDF4; extra == "full"
-Requires-Dist: pyrsktools; extra == "full"
 Requires-Dist: scipy; extra == "full"
 Requires-Dist: pfit==0.2.1; extra == "full"
+Requires-Dist: netCDF4; extra == "full"
+Requires-Dist: pyrsktools; extra == "full"
 Requires-Dist: openpyxl; extra == "full"
 Provides-Extra: dev
 Requires-Dist: manuel; extra == "dev"

{tsp-1.8.0.dist-info → tsp-1.8.1.dist-info}/RECORD

@@ -1,7 +1,7 @@
 tsp/__init__.py,sha256=V_rDl4XxSRtbFWK7KFZJkKqwjqwLREvlnVc7BCGjHaw,427
-tsp/__meta__.py,sha256=HPbBgUW82WNWV430sfTj9LXxF17fdFaQrKi-NL5mOo0,93
+tsp/__meta__.py,sha256=tX7kLpRWOrz5cd1yN8hSxvnQEMfxFz00EFtGKA45M4k,93
 tsp/concatenation.py,sha256=XK-5ec_IrlIVShp9eqd5QVg1yDgk3ysPFzeJpo2G2gc,5990
-tsp/core.py,sha256=gXGyY08_EHo2rttH2nqKMD3hUnVBrPQbjlNm-2ZXMME,37899
+tsp/core.py,sha256=bRsX_qs7cGJtxe40V50TYulAMWaIzUj1EtQcVD56jtY,39915
 tsp/gtnp.py,sha256=cFFSOVzudEkxqtXSMnsVE7clVoXFH0Gb8ES-Cx_iwUU,4269
 tsp/labels.py,sha256=URV4zxfur6aYojdra7KGTipFdiN9pAOCEVvkcc2pj-Q,78
 tsp/misc.py,sha256=y0NvW5jOlli5s220QnaLYTOadSlj3Lyu-EE-RsoSbok,2614
@@ -10,7 +10,7 @@ tsp/readers.py,sha256=1rPcS9eRpkGPWU6MsSrgiMh2QCKvAAY5_KiTQMMcsxk,18464
 tsp/time.py,sha256=82h7nxM-iXs2XwetF-alLtNvUm0qRtAA111gTMp5SY4,1379
 tsp/tspwarnings.py,sha256=AGCmSlwM3JbnrEZSbyBKLnyQkKygsKU_YYbte4iZsK8,399
 tsp/utils.py,sha256=sOJSZLmfv7sh4X971_gNgtZvXtS8ZwGmUdqnUybcVE4,2932
-tsp/version.py,sha256=Xzb-lP-C0B-Xa7NdEdQP8ANIyFtMIaeq0GhSeSluzrk,15
+tsp/version.py,sha256=FS-CnweGXSAhfq0K-UkXsGZu941kSK-J2gYMkcnFVAI,15
 tsp/data/2023-01-06_755-test-Dataset_2031-Constant_Over_Interval-Hourly-Ground_Temperature-Thermistor_Automated.timeserie.csv,sha256=Q3Ssnoo_kiSn9_orZHjtMxQ02YbrjCAEQKs5sHPFJCg,171
 tsp/data/2023-01-06_755-test.metadata.txt,sha256=Ux1YGqmAmRQmMIqqK8-OloQXflg4Y45FRwdT-WgCg8c,5686
 tsp/data/NTGS_example_csv.csv,sha256=OirFmLRqj7TUYfAUHqKbZFSqQ-g3I13QwUfUzgiJ-h4,554
@@ -87,8 +87,8 @@ tsp/dataloggers/test_files/rbr_xl_003.DAT,sha256=ZEKheCvB1CiubY2kMngigY0NNhWTYAi
 tsp/dataloggers/test_files/rbr_xl_003.HEX,sha256=sunCD5C1t8l5y4p1b9iiHNsZUznYIuBLz4uwoGkZh3E,118459
 tsp/plots/__init__.py,sha256=i5AhpNwyuT6il7uk2Vtc4YBjVnZ0ifvHNXw19rvDtsM,71
 tsp/plots/static.py,sha256=pvLFM3_HuRgnPMe7smxj9v65zcM3JLsCvhhwGgdt5Uk,13836
-tsp-1.8.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-tsp-1.8.0.dist-info/METADATA,sha256=rvZdIOFdzkkQe3Euae8ESNPAL2p6HukH2BRj-r2Auys,3271
-tsp-1.8.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-tsp-1.8.0.dist-info/top_level.txt,sha256=7tOR6y7BarphfWD2D7QFi_3F1jxagUZpHG8zwJIw4ck,30
-tsp-1.8.0.dist-info/RECORD,,
+tsp-1.8.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+tsp-1.8.1.dist-info/METADATA,sha256=_T7ZVlB3FOdmkzHzHUSTA7uSD2fI0GHRs79zRTqgIdY,3271
+tsp-1.8.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+tsp-1.8.1.dist-info/top_level.txt,sha256=7tOR6y7BarphfWD2D7QFi_3F1jxagUZpHG8zwJIw4ck,30
+tsp-1.8.1.dist-info/RECORD,,