diff --git a/README.md b/README.md index 6100768..490037d 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,11 @@ nu.by_tile_aop(dpid="DP3.30015.001", ``` +To install the development version (not recommended): +``` +$ pip install git+https://github.com/NEONScience/NEON-utilities-python.git@main +``` Credits & Acknowledgements --- diff --git a/dist/neonutilities-1.0.1-py3-none-any.whl b/dist/neonutilities-1.0.1-py3-none-any.whl new file mode 100644 index 0000000..1c4a4ec Binary files /dev/null and b/dist/neonutilities-1.0.1-py3-none-any.whl differ diff --git a/dist/neonutilities-1.0.1.tar.gz b/dist/neonutilities-1.0.1.tar.gz new file mode 100644 index 0000000..cf3ec4c Binary files /dev/null and b/dist/neonutilities-1.0.1.tar.gz differ diff --git a/pyproject.toml b/pyproject.toml index 22c8b71..418abb4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "neonutilities" -version = "1.0.0" +version = "1.0.1" authors = [ {name="Claire Lunch", email="clunch@battelleecology.org"}, {name="Bridget Hass", email="bhass@battelleecology.org"}, diff --git a/src/neonutilities/get_issue_log.py b/src/neonutilities/get_issue_log.py index e79533e..cd336bc 100644 --- a/src/neonutilities/get_issue_log.py +++ b/src/neonutilities/get_issue_log.py @@ -107,6 +107,13 @@ def get_issue_log(dpid, token=None): 'parentIssueID', 'issueDate', 'resolvedDate', 'dateRangeStart', 'dateRangeEnd', 'locationAffected', 'issue', 'resolution'; all other data products have the same columns minus 'dpid' + + Example + ------- + Get the issue log for Breeding landbird point counts (DP1.10003.001) + + >>> birdiss = get_issue_log(dpid="DP1.10003.001") + """ # raise value error and print message if dpid isn't formatted as expected validate_dpid(dpid) diff --git a/src/neonutilities/read_table_neon.py b/src/neonutilities/read_table_neon.py index cf483e9..bb70870 100644 --- a/src/neonutilities/read_table_neon.py +++ b/src/neonutilities/read_table_neon.py @@ -26,9 +26,8 @@ def read_table_neon(data_file, Example -------- - ZN NOTE: Insert example when function is coded - - >>> example + >>> dattab = read_table_neon(data_file="path to data table file", + var_file="path to variables file matching data table") Created on Thu Feb 1 2024 @@ -93,7 +92,7 @@ def date_convert(dates): Example -------- - d = date_convert("2023-08-01") + >>> d = date_convert("2023-08-01") Created on 2 May 2024 diff --git a/src/neonutilities/unzip_and_stack.py b/src/neonutilities/unzip_and_stack.py index 95d71bc..fc744f0 100644 --- a/src/neonutilities/unzip_and_stack.py +++ b/src/neonutilities/unzip_and_stack.py @@ -146,12 +146,6 @@ def get_recent_publication(filepaths): -------- The filepath of the file with the most recent publication date - Example - -------- - ZN NOTE: Insert example when function is coded - - >>> example - Created on Wed Apr 17 2024 @author: Zachary Nickerson @@ -183,12 +177,6 @@ def get_variables(v): -------- A pyarrow schema for data types based on the variables file - Example - -------- - ZN NOTE: Insert example when function is coded - - >>> example - Created on Wed Apr 17 2024 @author: Zachary Nickerson @@ -439,12 +427,6 @@ def format_readme(readmetab, -------- A modified readme file formatted to remove site-specific information and include standard information about the neonutilities download - Example - -------- - ZN NOTE: Insert example when function is coded - - >>> example - Created on Fri Jul 12 2024 @author: Zachary Nickerson @@ -497,12 +479,6 @@ def stack_data_files_parallel(folder, -------- One file for each table type is created and written. - Example - -------- - ZN NOTE: Insert example when function is coded - - >>> example - Created on Tue Apr 2 2024 @author: Zachary Nickerson @@ -866,9 +842,8 @@ def stack_by_table(filepath, Example -------- - ZN NOTE: Insert example when function is coded - - >>> example + # To stack PAR data (DP1.00024.001) downloaded from the NEON data portal + >>> pardat = stack_by_table("/filepath/NEON_par.zip") Created on Tue Mar 5 2024 @@ -1058,9 +1033,9 @@ def load_by_product(dpid, site="all", startdate=None, enddate=None, -------- Download water quality data from COMO (Como Creek) in 2018 - >>> load_by_product(dpid="DP1.20288.001",site="COMO", - startdate="2018-01", enddate="2018-12", - token=None) + >>> wq = load_by_product(dpid="DP1.20288.001",site="COMO", + startdate="2018-01", enddate="2018-12", + token=None) Created on June 12 2024