nctoolkit 1.1.11__tar.gz → 1.2.0__tar.gz

nctoolkit-1.2.0/CONTRIBUTIONS.md

@@ -0,0 +1,39 @@
+Contributing to nctoolkit
+
+🎉 Thank you for your interest in contributing to nctoolkit! Your efforts help improve this tool for the entire community. Whether you're fixing bugs, adding new features, or enhancing documentation, your contributions are invaluable. Let's make this project even better together! 🎉
+
+How to Contribute
+
+To contribute, please follow these steps:
+
+1. Fork the Repository
+Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.
+
+2. Clone and Set Up the Repository
+After forking, open your terminal, clone the repository to your local machine, and navigate into the project directory:
+git clone https://github.com/your-username/nctoolkit.git
+cd nctoolkit
+
+3. Create a New Branch
+Create a new branch for your contribution to keep your changes organized and separated from the main codebase:
+git checkout -b feature/your-feature-name
+
+4. Make Your Changes
+Add your feature, fix bugs, or improve documentation. Be sure to:
+Keep your changes focused on a single feature or fix for easier review.
+Test your modifications to ensure they work as intended.
+Follow any coding style guidelines noted in the project.
+
+5. Commit Your Changes
+When you’re ready, stage and commit your changes with a clear, descriptive commit message:
+git add .
+git commit -m "Add detailed description of your changes here"
+
+6. Push to Your Fork
+Push your branch to your GitHub repository:
+git push origin feature/your-feature-name
+
+7. Submit a Pull Request (PR)
+Go to the original nctoolkit repository on GitHub.
+Click the "New Pull Request" button and select your branch.
+Include a detailed description of your changes to help reviewers understand your contribution.

{nctoolkit-1.1.11 → nctoolkit-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nctoolkit
-Version: 1.1.11
+Version: 1.2.0
 Summary: A Python package for netCDF analysis and post-processing
 Home-page: https://github.com/pmlmodelling/nctoolkit
 Author: Robert Wilson

{nctoolkit-1.1.11 → nctoolkit-1.2.0}/nctoolkit/assign.py

@@ -91,6 +91,8 @@ funs = [
     "exp",
     "ln",
     "sin",
+    "min",
+    "max",
     "cos",
     "tan",
     "int",

{nctoolkit-1.1.11 → nctoolkit-1.2.0}/nctoolkit/cleanup.py

@@ -145,12 +145,12 @@ def temp_check():
         if len(mylist) > 0:
             if len(mylist) == 1:
                 print(
-                    f"{len(mylist)} file was created by nctoolkit in prior or current "
+                    f"{len(mylist)} temporary file was created by nctoolkit in prior or current "
                     f"sessions. Consider running deep_clean!"
                 )
             else:
                 print(
-                    f"{len(mylist)} files were created by nctoolkit in prior or current"
+                    f"{len(mylist)} temporary files were created by nctoolkit in prior or current"
                     f" sessions. Consider running deep_clean!"
                 )
 
@@ -163,12 +163,12 @@ def temp_check():
         if len(mylist) > 0:
             if len(mylist) == 1:
                 print(
-                    f"{len(mylist)} file was created by nctoolkit in prior or current "
+                    f"{len(mylist)} temporary file was created by nctoolkit in prior or current "
                     f"sessions. Consider running deep_clean!"
                 )
             else:
                 print(
-                    f"{len(mylist)} files were created by nctoolkit in prior or "
+                    f"{len(mylist)} temporary files were created by nctoolkit in prior or "
                     f"current sessions. Consider running deep_clean!"
                 )
 

{nctoolkit-1.1.11 → nctoolkit-1.2.0}/nctoolkit/subset.py

@@ -45,24 +45,30 @@ def select_levels(self, levels=None):
     levels : list
         List of the form [min_level, max_level]. Levels/depth between the two will be selected
     """
+    ds_levels = self.levels
+
     if not isinstance(levels, list):
         type(levels)
         try:
             levels = float(levels)
         except:
             raise ValueError("levels provided are not valid!")
+        levels = [float(levels), float(levels)]
 
     if isinstance(levels, list):
         try:
-            levels[0] = int(np.floor(float(levels[0])))
-            levels[1] = int(np.ceil(float(levels[1])))
+            levels[0] = float(levels[0])
+            levels[1] = float(levels[1])
         except:
             raise ValueError("levels provided are not valid!")
         if levels[0] > levels[1]:
             raise ValueError("levels have the wrong order")
-        levels = f"{levels[0]}/{levels[1]}"
-
-    cdo_command = f"-sellevel,{levels}"
+    
+    sel_levels = [str(x) for x in ds_levels if levels[0] <= x <= levels[1]]
+    if len(sel_levels) == 0:
+        raise ValueError("No levels found in the dataset")
+    sel_levels = ",".join(sel_levels)
+    cdo_command = f"-sellevel,{sel_levels}"
 
     self.cdo_command(cdo_command, ensemble=False)
 

{nctoolkit-1.1.11 → nctoolkit-1.2.0}/nctoolkit/toxarray.py

@@ -102,7 +102,7 @@ def to_xarray(self, decode_times=True, **kwargs):
         return data
 
 
-def to_dataframe(self, decode_times=True, **kwargs):
+def to_dataframe(self, decode_times=True, drop_bnds = True, **kwargs):
     """
     to_dataframe: Convert a dataset to a pandas data frame
 
@@ -111,6 +111,10 @@ def to_dataframe(self, decode_times=True, **kwargs):
     decode_times: boolean
         Set to False if you do not want xarray to decode the times prior to
         conversion to data frame. Default is True.
+    drop_bnds: boolean
+        Set to False if you do not want to drop the bounds from the data frame.
+        Variables/coordinates with '_bnds' in their names will be dropped.
+        Default is True.
     **kwargs : kwargs
         Optional arguments to be sent to subset.
 
@@ -125,4 +129,9 @@ def to_dataframe(self, decode_times=True, **kwargs):
     >>> ds.to_dataframe()
 
     """
-    return self.to_xarray(decode_times=decode_times, **kwargs).to_dataframe()
+    df = self.to_xarray(decode_times=decode_times, **kwargs).to_dataframe()
+    df = df.reset_index()
+    if drop_bnds:
+        df = df.drop(columns=[col for col in df.columns if 'bnds' in col])
+    df = df.drop_duplicates().reset_index(drop = True)
+    return df 

{nctoolkit-1.1.11 → nctoolkit-1.2.0}/nctoolkit/verticals.py

@@ -180,6 +180,9 @@ def vertical_interp(
     if thickness is not None:
         fixed = False
 
+    if isinstance(levels, (int, float)):
+        levels = [levels]
+
     if fixed is False:
         self.to_zlevels(
             levels=levels, thickness=thickness, depths=depths, surface=surface
@@ -191,8 +194,6 @@ def vertical_interp(
 
     # first a quick fix for the case when there is only one vertical depth
 
-    if isinstance(levels, (int, float)):
-        levels = [levels]
 
     # levels = [float(x) for x in levels]
 

{nctoolkit-1.1.11 → nctoolkit-1.2.0}/nctoolkit.egg-info/SOURCES.txt

@@ -1,5 +1,6 @@
 CITATION.cff
 CODE_OF_CONDUCT.md
+CONTRIBUTIONS.md
 LICENSE
 MANIFEST.in
 README.md

{nctoolkit-1.1.11 → nctoolkit-1.2.0}/setup.py

@@ -46,7 +46,7 @@ extras_require["complete"] = ["geoviews", "rioxarray", "cfchecker", "geocube", "
 REQUIREMENTS = [i.strip() for i in open("requirements.txt").readlines()]
 
 setup(name='nctoolkit',
-      version='1.1.11',
+      version='1.2.0',
       description=DESCRIPTION,
       description_content_type='text/plain',
       long_description=LONG_DESCRIPTION,