oafuncs 0.0.86__py2.py3-none-any.whl → 0.0.87__py2.py3-none-any.whl

oafuncs/oa_help.py

@@ -23,8 +23,10 @@ __all__ = ["query", "use", "log"]
 
 def query():
     """
-    description: 查看oafuncs模块的函数列表
-    example: query()
+    Description:
+        Show the number of functions and the list of functions in the module.
+    Example:
+        query()
     """
     funcs = [func for func in dir(oafuncs) if callable(getattr(oafuncs, func))]
     print("函数数量：")
@@ -62,9 +64,12 @@ def _use_single(func="get_var", module="oafuncs"):
 
 def use(func_name='log'):
     """
-    description: 查看本库指定函数的所有模块全路径和函数提示
-    param {func_name} : 函数名
-    example: use('get_var')
+    Description:
+        Show the full path and help of the function.
+    Args:
+        func_name: The name of the function.
+    Example:
+        use('log')
     """
     found = False
     # 假设oafuncs是一个包
@@ -105,10 +110,19 @@ def use(func_name='log'):
 
 def log():
     """
-    description: 查看更新日志
-    example: log()
+    Description:
+        Show the update log.
+    Example:
+        log()
     """
     print("更新日志：")
+    print(
+        """
+        2025-01-04
+        1. 下调Python支持版本到3.7，但未经过测试
+        2. 优化了部分函数说明
+        """
+    )
     print(
         """
         2025-01-01

oafuncs/oa_nc.py

@@ -24,10 +24,15 @@ __all__ = ["get_var", "extract", "save", "merge", "modify", "rename", "check_fil
 
 def get_var(file, *vars):
     """
-    description: 读取nc文件中的变量
-    param {file: 文件路径, *vars: 变量名}
-    example: datas = get_var(file_ecm, 'h', 't', 'u', 'v')
-    return {datas: 变量数据}
+    Description:
+        Read variables from nc file
+    Parameters:
+        file: str, file path
+        *vars: str, variable name or variable names; should be in same size
+    Example:
+        datas = get_var(file_ecm, 'h', 't', 'u', 'v')
+    Return:
+        datas: list, variable data
     """
     ds = xr.open_dataset(file)
     datas = []
@@ -40,15 +45,15 @@ def get_var(file, *vars):
 
 def extract(file, varname, only_value=True):
     """
-    描述：
-    1、提取nc文件中的变量
-    2、将相应维度提取，建立字典
-    return：返回变量及坐标字典
-    参数：
-    file: 文件路径
-    varname: 变量名
-    only_value: 变量和维度是否只保留数值
-    example: data, dimdict = extract(file_ecm, 'h')
+    Description:
+        Extract variables from nc file
+        Return the variable and coordinate dictionary
+    Parameters:
+        file: str, file path
+        varname: str, variable name
+        only_value: bool, whether to keep only the value of the variable and dimension
+    Example:
+        data, dimdict = extract('test.nc', 'h')
     """
     ds = xr.open_dataset(file)
     vardata = ds[varname]
@@ -103,18 +108,18 @@ def _calculate_scale_and_offset(data, n=16):
 
 def save(file, data, varname=None, coords=None, mode="w", scale_offset_switch=True, compile_switch=True):
     """
-    description: 写入数据到nc文件
-
-    参数：
-    file: 文件路径
-    data: 数据
-    varname: 变量名
-    coords: 坐标，字典，键为维度名称，值为坐标数据
-    mode: 写入模式，'w'为写入，'a'为追加
-    scale_offset_switch: 是否使用scale_factor和add_offset，默认为True
-    compile_switch: 是否使用压缩参数，默认为True
-
-    example: save(r'test.nc', data, 'data', {'time': np.linspace(0, 120, 100), 'lev': np.linspace(0, 120, 50)}, 'a')
+    Description:
+        Write data to NetCDF file
+    Parameters:
+        file: str, file path
+        data: data
+        varname: str, variable name
+        coords: dict, coordinates, key is the dimension name, value is the coordinate data
+        mode: str, write mode, 'w' for write, 'a' for append
+        scale_offset_switch: bool, whether to use scale_factor and add_offset, default is True
+        compile_switch: bool, whether to use compression parameters, default is True
+    Example:
+        save(r'test.nc', data, 'u', {'time': np.linspace(0, 120, 100), 'lev': np.linspace(0, 120, 50)}, 'a')
     """
     # 设置压缩参数
     kwargs = {"zlib": True, "complevel": 4} if compile_switch else {}
@@ -177,20 +182,21 @@ def save(file, data, varname=None, coords=None, mode="w", scale_offset_switch=Tr
 
 def merge(file_list, var_name=None, dim_name=None, target_filename=None):
     """
-    批量提取 nc 文件中的变量，按照某一维度合并后写入新的 nc 文件。
-    如果 var_name 是字符串，则认为是单变量；如果是列表，且只有一个元素，也是单变量；
-    如果列表元素大于1，则是多变量；如果 var_name 是 None，则合并所有变量。
-
-    参数：
-    file_list：nc 文件路径列表
-    var_name：要提取的变量名或变量名列表，默认为 None，表示提取所有变量
-    dim_name：用于合并的维度名
-    target_filename：合并后的目标文件名
-    
-    example: 
-    merge(file_list, var_name='data', dim_name='time', target_filename='merged.nc')
-    merge(file_list, var_name=['data1', 'data2'], dim_name='time', target_filename='merged.nc')
-    merge(file_list, var_name=None, dim_name='time', target_filename='merged.nc')
+    Description:
+        Merge variables from multiple NetCDF files along a specified dimension and write to a new file.
+        If var_name is a string, it is considered a single variable; if it is a list and has only one element, it is also a single variable;
+        If the list has more than one element, it is a multi-variable; if var_name is None, all variables are merged.
+        
+    Parameters:
+        file_list: List of NetCDF file paths
+        var_name: Name of the variable to be extracted or a list of variable names, default is None, which means all variables are extracted
+        dim_name: Dimension name used for merging
+        target_filename: Target file name after merging
+        
+    Example:
+        merge(file_list, var_name='u', dim_name='time', target_filename='merged.nc')
+        merge(file_list, var_name=['u', 'v'], dim_name='time', target_filename='merged.nc')
+        merge(file_list, var_name=None, dim_name='time', target_filename='merged.nc')
     """
     if isinstance(file_list, str):
         file_list = [file_list]
@@ -249,15 +255,17 @@ def merge(file_list, var_name=None, dim_name=None, target_filename=None):
 
 
 def _modify_var(nc_file_path, variable_name, new_value):
-    """
-    使用 netCDF4 库修改 NetCDF 文件中特定变量的值
-
-    参数：
-    nc_file_path (str): NetCDF 文件路径
-    variable_name (str): 要修改的变量名
-    new_value (numpy.ndarray): 新的变量值
-
-    example: modify_var('test.nc', 'data', np.random.rand(100, 50))
+    """    
+    Description:
+        Modify the value of a variable in a NetCDF file using the netCDF4 library.
+        
+    Parameters:
+        nc_file_path (str): The path to the NetCDF file.
+        variable_name (str): The name of the variable to be modified.
+        new_value (numpy.ndarray): The new value of the variable.
+        
+    Example:
+        modify_var('test.nc', 'u', np.random.rand(100, 50))
     """
     try:
         # Open the NetCDF file
@@ -273,15 +281,18 @@ def _modify_var(nc_file_path, variable_name, new_value):
 
 
 def _modify_attr(nc_file_path, variable_name, attribute_name, attribute_value):
-    """
-    使用 netCDF4 库添加或修改 NetCDF 文件中特定变量的属性。
-
-    参数：
-    nc_file_path (str): NetCDF 文件路径
-    variable_name (str): 要操作的变量名
-    attribute_name (str): 属性名
-    attribute_value (任意类型): 属性值
-    example: modify_attr('test.nc', 'temperature', 'long_name', 'Temperature in Celsius')
+    """   
+    Description:
+        Add or modify an attribute of a variable in a NetCDF file using the netCDF4 library.
+        
+    Parameters:
+        nc_file_path (str): The path to the NetCDF file.
+        variable_name (str): The name of the variable to be modified.
+        attribute_name (str): The name of the attribute to be added or modified.
+        attribute_value (any): The value of the attribute.
+        
+    Example:
+        modify_attr('test.nc', 'temperature', 'long_name', 'Temperature in Celsius')
     """
     try:
         ds = nc.Dataset(nc_file_path, "r+")
@@ -303,15 +314,18 @@ def _modify_attr(nc_file_path, variable_name, attribute_name, attribute_value):
 
 def modify(nc_file,var_name,attr_name=None,new_value=None):
     """
-    description: 修改nc文件中的变量值或属性值
-    parameters:
-        nc_file: str, nc文件路径
-        var_name: str, 变量名
-        attr_name: str, 属性名; None表示修改变量值
-        new_value: 任意类型, 新的变量值或属性值
-    example: 
-        modify(nc_file, 'h', 'long_name', 'Height')
-        modify(nc_file, 'h', None, np.random.rand(100, 50))
+    Description:
+        Modify the value of a variable or the value of an attribute in a NetCDF file.
+        
+    Parameters:
+        nc_file (str): The path to the NetCDF file.
+        var_name (str): The name of the variable to be modified.
+        attr_name (str): The name of the attribute to be modified. If None, the variable value will be modified.
+        new_value (any): The new value of the variable or attribute.
+        
+    Example:
+        modify('test.nc', 'temperature', 'long_name', 'Temperature in Celsius')
+        modify('test.nc', 'temperature', None, np.random.rand(100, 50))
     """
     if attr_name is None:
         _modify_var(nc_file, var_name, new_value)
@@ -321,14 +335,16 @@ def modify(nc_file,var_name,attr_name=None,new_value=None):
 
 def rename(ncfile_path, old_name, new_name):
     """
-    Rename a variable and/or dimension in a NetCDF file.
+    Description:
+        Rename a variable and/or dimension in a NetCDF file.
 
     Parameters:
-    ncfile_path (str): The path to the NetCDF file.
-    old_name (str): The name of the variable or dimension to be renamed.
-    new_name (str): The new name for the variable or dimension.
+        ncfile_path (str): The path to the NetCDF file.
+        old_name (str): The current name of the variable or dimension.
+        new_name (str): The new name to assign to the variable or dimension.
 
-    example: rename('test.nc', 'time', 'ocean_time')
+    example:
+        rename('test.nc', 'temperature', 'temp')
     """
     try:
         with nc.Dataset(ncfile_path, "r+") as dataset:
@@ -355,14 +371,15 @@ def rename(ncfile_path, old_name, new_name):
 
 def check_file(ncfile, if_delete=False):
     '''
-    Description: 检查nc文件是否损坏
-    
+    Description:
+        Check if the NetCDF file is corrupted.
+        
     Parameters:
-        ncfile: str, nc文件路径
-        if_delete: bool, 是否删除损坏的文件，默认为False
-    
-    Example:
-        check_file(ncfile, if_delete=True)
+        ncfile (str): The path to the NetCDF file.
+        if_delete (bool): Whether to delete the file if it is corrupted, default is False.
+        
+    Returns:
+        bool: True if the file is not corrupted, False otherwise.
     '''
     if not os.path.exists(ncfile):
         return False
@@ -393,15 +410,16 @@ def check_file(ncfile, if_delete=False):
 
 def convert_longitude(ds, lon_name="longitude", convert=180):
     """
-    将经度数组转换为指定的范围。
-
-    参数：
-    ds (xarray.Dataset): 包含经度数据的xarray数据集。
-    lon_name (str): 经度变量的名称，默认为"longitude"。
-    convert (int): 转换目标范围，可以是180或360，默认为180。
-
-    返回值：
-    xarray.Dataset: 经度转换后的xarray数据集。
+    Description:
+        Convert the longitude array to a specified range.
+        
+    Parameters:
+        ds (xarray.Dataset): The xarray dataset containing the longitude data.
+        lon_name (str): The name of the longitude variable, default is "longitude".
+        convert (int): The target range to convert to, can be 180 or 360, default is 180.
+        
+    Returns:
+        xarray.Dataset: The xarray dataset with the converted longitude.
     """
     to_which = int(convert)
     if to_which not in [180, 360]:
@@ -417,18 +435,17 @@ def convert_longitude(ds, lon_name="longitude", convert=180):
 
 def isel(ncfile, dim_name, slice_list):
     """
-    Description: Choose the data by the index of the dimension
+    Description:
+        Choose the data by the index of the dimension
 
     Parameters:
         ncfile: str, the path of the netCDF file
         dim_name: str, the name of the dimension
         slice_list: list, the index of the dimension
 
-    slice_list example: slice_list = [[y*12+m for m in range(11,14)] for y in range(84)]
-                    or
-                        slice_list = [y * 12 + m for y in range(84) for m in range(11, 14)]
-    
     Example:
+        slice_list = [[y*12+m for m in range(11,14)] for y in range(84)]
+        slice_list = [y * 12 + m for y in range(84) for m in range(11, 14)]
         isel(ncfile, 'time', slice_list)
     """
     ds = xr.open_dataset(ncfile)

{oafuncs-0.0.86.dist-info → oafuncs-0.0.87.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: oafuncs
-Version: 0.0.86
-Summary: My short description for my project.
+Version: 0.0.87
+Summary: Oceanic and Atmospheric Functions
 Home-page: https://github.com/Industry-Pays/OAFuncs
 Author: Kun Liu
 Author-email: liukun0312@stu.ouc.edu.cn
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.9.0
+Requires-Python: >=3.7.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: matplotlib

{oafuncs-0.0.86.dist-info → oafuncs-0.0.87.dist-info}/RECORD

@@ -3,8 +3,8 @@ oafuncs/oa_cmap.py,sha256=azVg9QR_IlG9lXCCXXVs1LS1kFci8yjxDmb_VA_TdTQ,7408
 oafuncs/oa_data.py,sha256=2MkWCsESVPjZPnLnbQIwrBJUhcF9x-WXbZhni3I44ss,15617
 oafuncs/oa_draw.py,sha256=PUk8DdGBUapCXrOVQ-d_DD6EccB_eHAX3r6jwrnQTk8,11126
 oafuncs/oa_file.py,sha256=-AdRnFEtRTpIMXr5geYe5fEhyiMOFad5ethi_lF-Ogo,12277
-oafuncs/oa_help.py,sha256=zQEYXFn6eCiEgzSy_gSjhdP3u-KRK4Hl-iGIvPC8EAs,3729
-oafuncs/oa_nc.py,sha256=OeWtv__oPsLNLBS6mOIUCvb8X9GEj4qjjc10lJE-IHE,16432
+oafuncs/oa_help.py,sha256=DsX6rFPZ-ZMaexcyCXeGeB3h1zPScY6ijH-uLNVWidA,3988
+oafuncs/oa_nc.py,sha256=b8pbiPSRDi7Te42UcnR0AlW1sQEVtn5VU9ERiAdX-yY,17501
 oafuncs/oa_python.py,sha256=XPTP3o7zTFzfJR_YhsKfQksa3bSYwXsne9YxlJplCEA,3994
 oafuncs/data_store/OAFuncs.png,sha256=w2pR7MUyeeWrT8BVTSy40EIRDIrfpdo1QvWvvjLOgjM,3258809
 oafuncs/oa_down/User_Agent-list.txt,sha256=pazxSip8_lphEBOPHG902zmIBUg8sBKXgmqp_g6j_E4,661062
@@ -19,8 +19,8 @@ oafuncs/oa_sign/ocean.py,sha256=xrW-rWD7xBWsB5PuCyEwQ1Q_RDKq2KCLz-LOONHgldU,5932
 oafuncs/oa_sign/scientific.py,sha256=a4JxOBgm9vzNZKpJ_GQIQf7cokkraV5nh23HGbmTYKw,5064
 oafuncs/oa_tool/__init__.py,sha256=IKOlqpWlb4cMDCtq2VKR_RTxQHDNqR_vfqqsOsp_lKQ,466
 oafuncs/oa_tool/email.py,sha256=4lJxV_KUzhxgLYfVwYTqp0qxRugD7fvsZkXDe5WkUKo,3052
-oafuncs-0.0.86.dist-info/LICENSE.txt,sha256=rMtLpVg8sKiSlwClfR9w_Dd_5WubTQgoOzE2PDFxzs4,1074
-oafuncs-0.0.86.dist-info/METADATA,sha256=Bg1Cg7-c-UUc0gGBDqR3HsrbnK6Sz5JgEKz3vdz9SzA,3303
-oafuncs-0.0.86.dist-info/WHEEL,sha256=pxeNX5JdtCe58PUSYP9upmc7jdRPgvT0Gm9kb1SHlVw,109
-oafuncs-0.0.86.dist-info/top_level.txt,sha256=bgC35QkXbN4EmPHEveg_xGIZ5i9NNPYWqtJqaKqTPsQ,8
-oafuncs-0.0.86.dist-info/RECORD,,
+oafuncs-0.0.87.dist-info/LICENSE.txt,sha256=rMtLpVg8sKiSlwClfR9w_Dd_5WubTQgoOzE2PDFxzs4,1074
+oafuncs-0.0.87.dist-info/METADATA,sha256=s_MdtiHoS3sPMPmK2J1se2gWXs34fA2tHSjQ4NqH-cs,3300
+oafuncs-0.0.87.dist-info/WHEEL,sha256=pxeNX5JdtCe58PUSYP9upmc7jdRPgvT0Gm9kb1SHlVw,109
+oafuncs-0.0.87.dist-info/top_level.txt,sha256=bgC35QkXbN4EmPHEveg_xGIZ5i9NNPYWqtJqaKqTPsQ,8
+oafuncs-0.0.87.dist-info/RECORD,,