tadc 2.3.5__tar.gz

tadc-2.3.5/LICENSE.txt

@@ -0,0 +1 @@
+Software code created by U.S. Government employees is not subject to copyright in the United States (17 U.S.C. �105). The United States/Department of Commerce reserves all rights to seek and obtain copyright protection in countries other than the United States for Software authored in its entirety by the Department of Commerce. To this end, the Department of Commerce hereby grants to Recipient a royalty-free, nonexclusive license to use, copy, and create derivative works of the Software outside of the United States.

tadc-2.3.5/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: tadc
+Version: 2.3.5
+Summary: The Tidal Analysis Datum Calculator (TADC) computes tidal datums from a water level data time series.
+Author-email: "Center for Operational Oceanographic Products and Services, National Ocean Service, National Oceanic and Atmsopheric Administration" <tide.predictions@noaa.gov>
+Project-URL: Online Web App, https://access.co-ops.nos.noaa.gov/datumcalc/
+Project-URL: Technical Report, https://access.co-ops.nos.noaa.gov/datumcalc/docs/TechnicalReport.pdf
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas>=2.0.3
+Requires-Dist: python-dateutil
+Requires-Dist: requests
+Requires-Dist: scipy
+Dynamic: license-file
+
+# CO-OPS Tidal Analysis Datum Calculator (TADC)
+
+
+# Overview
+
+This is code for the NOAA Tidal Analysis Datum Calculator tool. 
+
+This tool computes tidal datums from a water level data time series. The TADC uses a Butterworth digital filter to remove high frequency (> 4 cycles/day) water level variability in order to identify tidal high and low waters from observed water level data. For official datums, CO-OPS uses a procedure called Curve Fit Manual Verification (CFMV) approach to identify tidal high and low waters that requires human oversight. The accuracy of this tool relative to the CO-OPS approach is described in detail in the following technical document:
+
+Licate LA, Huang L and Dusek G (2017) A Comparison of Datums Derived from CO-OPS Verified Data Products and Tidal Analysis Datum Calculator. [NOAA Technical Report NOS CO-OPS 085](https://access.co-ops.nos.noaa.gov/datumcalc/docs/TechnicalReport.pdf).
+
+For additional information, contact: NOAA's [Center for Operational Oceanographic Products and Services](https://tidesandcurrents.noaa.gov/)
+    User Services: tide.predictions@noaa.gov
+
+
+# Installation
+```bash
+pip install git+https://github.com/NOAA-CO-OPS/CO-OPS-Tidal-Analysis-Datum-Calculator
+```
+or
+```bash
+git clone https://github.com/NOAA-CO-OPS/dev_CO-OPS-Tidal-Analysis-Datum-Calculator
+cd dev_CO-OPS-Tidal-Analysis-Datum-Calculator
+conda env create -f environment.yml
+conda activate tadc
+```
+
+
+# Usage 
+You can run the TADC from the command line. Results will print to the terminal window:
+```bash
+python -m tadc.run --fname data\test_timeseries_simple.csv --Subordinate_Lat 37 --Subordinate_Lon -79
+```
+> [!NOTE]
+> Use `--outfile_save_dir C:\your\dir` and `--make_plots True` to save results and monthly diagnostic plots.
+
+Or, you can use TADC within other Python programs like so:
+```Python
+import tadc
+out = tadc.run(fname='data/test_timeseries_simple.csv', Subordinate_Lat=37, Subordinate_Lon=-79)
+summary = out.readme
+high_lows = out.high_lows
+monthly_plots = out.plots
+sub_monthly_means = out.subordinate_monthly_means
+datums = out.datums
+```
+Note that you can alternatively pass your timeseries directly to tadc as a `Pandas` `DataFrame`:
+```Python
+import pandas as pd
+import tadc
+timeseries = pd.read_csv('data/test_timeseries_simple.csv')
+out = tadc.run(data=timeseries, Subordinate_Lat=37.8, Subordinate_Lon=-79.6)
+```
+> [!NOTE]
+> One and only one of either `fname` or `data` must be specified when running `tadc()`
+
+The object returned by `tadc.run()` also supports some further analyses on the data, in particular `daily_max_analysis`, `daily_min_analysis`, and `inundation_analysis`:
+```Python
+out = tadc.run(data=timeseries, Subordinate_Lat=37.8, Subordinate_Lon=-79.6)
+daily_max_obj = out.daily_max_analysis(datum='MHHW')  # Do an analysis of daily maximums on MHHW #
+daily_maxs = daily_max_obj.daily_maxs  # returns the daily max timeseries #
+daily_max_obj.plot()  # creates a timeseries plot of the daily maxs #
+daily_min_obj = out.daily_min_analysis(datum='MHHW')  # Do an analysis of daily minimums on MHHW #
+# daily_min_obj has the same sub-methods as daily_max_obj #
+inundation_analysis_obj = out.inundation_analysis(threshold=0.5, threshold_datum='MHHW') # Do an analysis of inundations above MHHW+0.5 m #
+inundation_analysis_obj.inundations()  # returns the intervals of threshold exceedance #
+inundation_analysis_obj.plot()  # creates a plot of inundation time vs. depth #
+```
+
+# Parameters:
+Whether running from the command line or in Python, the following input arguments can be passed:
+
+| Argument &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Type &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `--fname` | `file path` | `None` | Required unless `--data` is specified.<br>The full path of the timeseries data to be analyzed.
+| `--data` | `pandas DataFrame` | `None` | Required unless `--fname` is specified.<br>The timeseries data to be analyzed as a Pandas DataFrame object. Only used in Python workflows.
+| `--Subordinate_Lat` | `float` | `None` | The latitude (in decimal degrees) of the station for which datums are being computed.
+| `--Subordinate_Lon` | `float` | `None` | The longitude (in decimal degrees) of the station for which datums are being computed.
+| `--Units` | {`'Meters'`,<br>`'Centimeters'`,<br>`'Feet'`,<br>`'Inches'`} | `'Meters'` | The units of the input data. All calculations will be done on these units.<br>**Warning** Must match the units of the input data.
+| `--Time_Zone` | `str` | `'GMT'` | The time zone of the input data. All calculations will be done in this timezone.<br>**Warning** Must match the time zone of the input data.
+| `--resample_minutes` | `int` | `None` | Resample the input data to this sampling rate (in minutes).<br> **Note** If your data are unevenly spaced in time, resampling will be done automatically at a detected interval which can be modified by setting this parameter.
+| `--Control_Station_ID` | `int` | `None` | The seven-digit station ID of the NWLON control station being used, if using a control station.
+| `--Method_Option` | {`'AUTO'`,<br>`'FRED'`,<br>`'TBYT'`,<br>`'MMSC'`} | `'AUTO'` | The datum adjustment method to use when using a control station.<br>`'AUTO'`: Auto select. If using a control station and <1 month of data 'TBYT' will be used, 'MMSC' otherwise. If not using a control station 'FRED' will be used.<br>`'FRED'`: First reduction method. No adjustment from control station, simple average of highs and lows.<br>`'TBYT'`: Tide by tide analysis. Compares simultaneous high/low waters at the input and control stations.<br>`'MMSC'`: Monthly means simultaneous comparison. Compares monthly means at the input and control stations.
+| `--Pick_Method` | {`'PolyFit'`,<br>`'Direct'`} | `'PolyFit'` | The method to pick high and low tide times and values.<br>`'PolyFit'`: Fit a polynomial to the observations and extract highs and lows from the fit.<br>`'Direct'`: Extract highs and lows directly from the input timeseries.
+| `--outfile_save_dir` | `directory path` | `None` | The directory into which to save output files, if run from the command line. No effect if run in a Python workflow.<br>**Note** A timestamped folder will be created containing the output files.
+| `--make_plots` | `bool` | `False` | Whether or not to create plots, one per month, showing the extracted high and low tides.<br>**Warning** To save plots when running from the command line, `--outfile_save_dir` must also be specified. If running in a Python workflow, plots will be created as Python objects.
+
+
+# NOAA Open Source Disclaimer
+
+This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an 'as is' basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.
+
+
+# License
+
+Software code created by U.S. Government employees is not subject to copyright in the United States (17 U.S.C. �105). The United States/Department of Commerce reserves all rights to seek and obtain copyright protection in countries other than the United States for Software authored in its entirety by the Department of Commerce. To this end, the Department of Commerce hereby grants to Recipient a royalty-free, nonexclusive license to use, copy, and create derivative works of the Software outside of the United States.

tadc-2.3.5/README.md

@@ -0,0 +1,96 @@
+# CO-OPS Tidal Analysis Datum Calculator (TADC)
+
+
+# Overview
+
+This is code for the NOAA Tidal Analysis Datum Calculator tool. 
+
+This tool computes tidal datums from a water level data time series. The TADC uses a Butterworth digital filter to remove high frequency (> 4 cycles/day) water level variability in order to identify tidal high and low waters from observed water level data. For official datums, CO-OPS uses a procedure called Curve Fit Manual Verification (CFMV) approach to identify tidal high and low waters that requires human oversight. The accuracy of this tool relative to the CO-OPS approach is described in detail in the following technical document:
+
+Licate LA, Huang L and Dusek G (2017) A Comparison of Datums Derived from CO-OPS Verified Data Products and Tidal Analysis Datum Calculator. [NOAA Technical Report NOS CO-OPS 085](https://access.co-ops.nos.noaa.gov/datumcalc/docs/TechnicalReport.pdf).
+
+For additional information, contact: NOAA's [Center for Operational Oceanographic Products and Services](https://tidesandcurrents.noaa.gov/)
+    User Services: tide.predictions@noaa.gov
+
+
+# Installation
+```bash
+pip install git+https://github.com/NOAA-CO-OPS/CO-OPS-Tidal-Analysis-Datum-Calculator
+```
+or
+```bash
+git clone https://github.com/NOAA-CO-OPS/dev_CO-OPS-Tidal-Analysis-Datum-Calculator
+cd dev_CO-OPS-Tidal-Analysis-Datum-Calculator
+conda env create -f environment.yml
+conda activate tadc
+```
+
+
+# Usage 
+You can run the TADC from the command line. Results will print to the terminal window:
+```bash
+python -m tadc.run --fname data\test_timeseries_simple.csv --Subordinate_Lat 37 --Subordinate_Lon -79
+```
+> [!NOTE]
+> Use `--outfile_save_dir C:\your\dir` and `--make_plots True` to save results and monthly diagnostic plots.
+
+Or, you can use TADC within other Python programs like so:
+```Python
+import tadc
+out = tadc.run(fname='data/test_timeseries_simple.csv', Subordinate_Lat=37, Subordinate_Lon=-79)
+summary = out.readme
+high_lows = out.high_lows
+monthly_plots = out.plots
+sub_monthly_means = out.subordinate_monthly_means
+datums = out.datums
+```
+Note that you can alternatively pass your timeseries directly to tadc as a `Pandas` `DataFrame`:
+```Python
+import pandas as pd
+import tadc
+timeseries = pd.read_csv('data/test_timeseries_simple.csv')
+out = tadc.run(data=timeseries, Subordinate_Lat=37.8, Subordinate_Lon=-79.6)
+```
+> [!NOTE]
+> One and only one of either `fname` or `data` must be specified when running `tadc()`
+
+The object returned by `tadc.run()` also supports some further analyses on the data, in particular `daily_max_analysis`, `daily_min_analysis`, and `inundation_analysis`:
+```Python
+out = tadc.run(data=timeseries, Subordinate_Lat=37.8, Subordinate_Lon=-79.6)
+daily_max_obj = out.daily_max_analysis(datum='MHHW')  # Do an analysis of daily maximums on MHHW #
+daily_maxs = daily_max_obj.daily_maxs  # returns the daily max timeseries #
+daily_max_obj.plot()  # creates a timeseries plot of the daily maxs #
+daily_min_obj = out.daily_min_analysis(datum='MHHW')  # Do an analysis of daily minimums on MHHW #
+# daily_min_obj has the same sub-methods as daily_max_obj #
+inundation_analysis_obj = out.inundation_analysis(threshold=0.5, threshold_datum='MHHW') # Do an analysis of inundations above MHHW+0.5 m #
+inundation_analysis_obj.inundations()  # returns the intervals of threshold exceedance #
+inundation_analysis_obj.plot()  # creates a plot of inundation time vs. depth #
+```
+
+# Parameters:
+Whether running from the command line or in Python, the following input arguments can be passed:
+
+| Argument                                                     | Type                                  | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `--fname` | `file path` | `None` | Required unless `--data` is specified.<br>The full path of the timeseries data to be analyzed.
+| `--data` | `pandas DataFrame` | `None` | Required unless `--fname` is specified.<br>The timeseries data to be analyzed as a Pandas DataFrame object. Only used in Python workflows.
+| `--Subordinate_Lat` | `float` | `None` | The latitude (in decimal degrees) of the station for which datums are being computed.
+| `--Subordinate_Lon` | `float` | `None` | The longitude (in decimal degrees) of the station for which datums are being computed.
+| `--Units` | {`'Meters'`,<br>`'Centimeters'`,<br>`'Feet'`,<br>`'Inches'`} | `'Meters'` | The units of the input data. All calculations will be done on these units.<br>**Warning** Must match the units of the input data.
+| `--Time_Zone` | `str` | `'GMT'` | The time zone of the input data. All calculations will be done in this timezone.<br>**Warning** Must match the time zone of the input data.
+| `--resample_minutes` | `int` | `None` | Resample the input data to this sampling rate (in minutes).<br> **Note** If your data are unevenly spaced in time, resampling will be done automatically at a detected interval which can be modified by setting this parameter.
+| `--Control_Station_ID` | `int` | `None` | The seven-digit station ID of the NWLON control station being used, if using a control station.
+| `--Method_Option` | {`'AUTO'`,<br>`'FRED'`,<br>`'TBYT'`,<br>`'MMSC'`} | `'AUTO'` | The datum adjustment method to use when using a control station.<br>`'AUTO'`: Auto select. If using a control station and <1 month of data 'TBYT' will be used, 'MMSC' otherwise. If not using a control station 'FRED' will be used.<br>`'FRED'`: First reduction method. No adjustment from control station, simple average of highs and lows.<br>`'TBYT'`: Tide by tide analysis. Compares simultaneous high/low waters at the input and control stations.<br>`'MMSC'`: Monthly means simultaneous comparison. Compares monthly means at the input and control stations.
+| `--Pick_Method` | {`'PolyFit'`,<br>`'Direct'`} | `'PolyFit'` | The method to pick high and low tide times and values.<br>`'PolyFit'`: Fit a polynomial to the observations and extract highs and lows from the fit.<br>`'Direct'`: Extract highs and lows directly from the input timeseries.
+| `--outfile_save_dir` | `directory path` | `None` | The directory into which to save output files, if run from the command line. No effect if run in a Python workflow.<br>**Note** A timestamped folder will be created containing the output files.
+| `--make_plots` | `bool` | `False` | Whether or not to create plots, one per month, showing the extracted high and low tides.<br>**Warning** To save plots when running from the command line, `--outfile_save_dir` must also be specified. If running in a Python workflow, plots will be created as Python objects.
+
+
+# NOAA Open Source Disclaimer
+
+This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an 'as is' basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.
+
+
+# License
+
+Software code created by U.S. Government employees is not subject to copyright in the United States (17 U.S.C. �105). The United States/Department of Commerce reserves all rights to seek and obtain copyright protection in countries other than the United States for Software authored in its entirety by the Department of Commerce. To this end, the Department of Commerce hereby grants to Recipient a royalty-free, nonexclusive license to use, copy, and create derivative works of the Software outside of the United States.

tadc-2.3.5/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tadc"
+version = "2.3.5"
+description = "The Tidal Analysis Datum Calculator (TADC) computes tidal datums from a water level data time series."
+readme = "README.md"
+authors = [
+  { name="Center for Operational Oceanographic Products and Services, National Ocean Service, National Oceanic and Atmsopheric Administration", email="tide.predictions@noaa.gov" }
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.0"
+dependencies = [
+    "matplotlib",
+	"numpy",
+	"pandas>=2.0.3",
+	"python-dateutil",
+	"requests",
+	"scipy"
+]
+license-files = ["LICENSE.txt"]
+
+[project.urls]
+"Online Web App" = "https://access.co-ops.nos.noaa.gov/datumcalc/"
+"Technical Report" = "https://access.co-ops.nos.noaa.gov/datumcalc/docs/TechnicalReport.pdf"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["tadc*"]
+namespaces = false

tadc-2.3.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tadc-2.3.5/tadc/__init__.py

@@ -0,0 +1 @@
+from .run import *

tadc-2.3.5/tadc/control_data.py

@@ -0,0 +1,97 @@
+"""CO-OPS API data retrieval functions for CO-OPS Datums Calculator"""
+
+from datetime import datetime, date, time, timedelta
+import numpy as np
+import pandas as pd
+import requests
+
+from . import tides as tf
+
+
+def Get_Monthly_Means(Control_Station_ID, Begin_Month, Begin_Year, End_Month, End_Year, Conversion):
+    #This function retrieves the control station's monthly means using CO-OPS data api 
+    end_days = tf.Last_Day_In_Month(int(End_Year),int(End_Month))
+    if int(Begin_Month) < 10:
+        sb = '0'
+    else:
+        sb = ''
+    if int(End_Month) < 10:
+        se = '0'
+    else:
+        se = ''    
+    url1 = 'https://api.tidesandcurrents.noaa.gov/api/prod/datagetter?'
+    url2 = 'begin_date=' + str(Begin_Year) + sb + str(Begin_Month) + '01' + '&end_date=' + str(End_Year) + se + str(End_Month) + str(end_days) + '&station=' + str(Control_Station_ID)
+    url3 = '&product=monthly_mean&datum=stnd&units=metric&time_zone=gmt&application=TADC&format=json'
+    r = requests.get(url1 + url2 + url3)
+    MM = pd.DataFrame(r.json()['data'])
+    for c in ['highest','MHHW','MHW','MSL','MLW','MLLW','lowest']:
+        MM[c]  = MM[c].astype(float) * Conversion
+    MM_lists = [MM[['highest','MHHW','MHW','MSL','MLW','MLLW','lowest']].iloc[i].values.tolist() for i in range(len(MM))]  # Convert to the list of lists format needed by run.py #
+    return MM_lists
+
+
+def Get_High_Lows(Control_Station_ID, Start_DT, End_DT, gmt_offset, Conversion):
+    #This function retrieves control station high and low tides using CO-OPS data api
+
+    #if subordinate (short-term) station time is not in gmt, get time offset
+    Start_DT += timedelta(hours=gmt_offset)
+    End_DT += timedelta(hours=gmt_offset)
+
+    if End_DT - Start_DT > timedelta(days=365):
+        chunks = pd.date_range(Start_DT, End_DT, periods=int(np.ceil((End_DT - Start_DT).days/365))+1)
+    else:
+        chunks = (Start_DT, End_DT)
+
+    hl_chunks = []
+    for i in range(len(chunks)-1):
+        start_dt = chunks[i]
+        end_dt = chunks[i+1]
+
+        start_datestr = datetime.strftime(start_dt,'%Y%m%d')
+        end_datestr = datetime.strftime(end_dt,'%Y%m%d')
+
+        url1 = 'https://api.tidesandcurrents.noaa.gov/api/prod/datagetter?'
+        url2 = 'begin_date=' + start_datestr + '&end_date=' + end_datestr + '&station=' + str(Control_Station_ID)
+        url3 = '&product=High_low&datum=stnd&units=metric&time_zone=gmt&application=TADC&format=json'    
+        r = requests.get(url1 + url2 + url3)
+
+        hl_chunks.append(pd.DataFrame(r.json()['data']))
+    HL = pd.concat(hl_chunks,ignore_index=True)
+    HL['t'] = pd.to_datetime(HL['t']) - timedelta(hours=gmt_offset)
+    HL['v']  = HL['v'].astype(float) * Conversion
+    HL['ty'] = [HL['ty'].iloc[i].replace(' ','') for i in range(len(HL))]
+    HL_lists = [HL[['t','v','ty']].iloc[i].values.tolist() for i in range(len(HL))]  # Convert to the list of lists format needed by run.py #
+    return HL_lists
+
+
+def Get_Accepted_Datums(Station_ID, Conversion):
+    #This function retrieves the accepted control station datums using CO-OPS metadata api
+    url = 'https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/' + str(Station_ID) + '/datums.json?units=metric'
+    r = requests.get(url)
+    datums = pd.DataFrame(r.json()['datums'])
+    SD = []
+    for datum in ['MHHW','MHW','DTL','MTL','MSL','MLW','MLLW','GT','MN','DHQ','DLQ','NAVD88','LWI','HWI']:
+        try:
+            val = datums.loc[datums['name'] == datum,'value'].values[0]
+        except IndexError:
+            SD.append(np.nan)
+        else:
+            if datum not in ['LWI','HWI']:
+                SD.append(val * Conversion)
+            else:
+                SD.append(val)
+    return SD
+
+
+def Get_SubMethod(Station_ID):
+    #This function checks if the control station is a West coast/Pacific or  East Coast/Gulf Coast/Caribbean Island station
+    #for choosing datum computation method
+    url = 'https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/' + str(Station_ID) + '.json?units=metric'
+    r = requests.get(url)
+    lon = r.json()['stations'][0]['lng']
+    if lon < -100:
+        return('Standard')
+    else:
+        return('Modified')
+
+

tadc-2.3.5/tadc/daily_extremes_analysis.py

@@ -0,0 +1,76 @@
+import matplotlib.pyplot as plt
+import numpy as np
+import pandas as pd
+
+
+class Out:
+    def __init__(self, daily_extremes, extremes_type, datum, units, input_file):
+        self.__daily_extremes = daily_extremes
+        if extremes_type == 'max':
+            self.daily_maxs = daily_extremes
+            self.daily_mins = None
+        elif extremes_type == 'min':
+            self.daily_mins = daily_extremes
+            self.daily_maxs = None
+        if datum == 'Input':
+            self.datum = 'input datum'
+        else:
+            self.datum = datum
+        self.units = units
+        self.input_file = input_file
+            
+    def percentile(self, prctile):
+        return self.__daily_extremes['elevation'].quantile(prctile/100)
+
+    def plot(self, prctile=None):
+        fig,ax = plt.subplots(1,figsize=(9,5))
+        ax.tick_params(axis='both',labelsize=8)
+        ax.grid('on',linestyle='--')
+        ax.plot(self.__daily_extremes['time'],self.__daily_extremes['elevation'],'-o',label='Daily max',zorder=2)
+        ax.set_ylabel('Elevation ('+self.units+' above '+self.datum+')',fontsize=8)
+        if prctile != None:
+            prctile_elev = self.percentile(prctile)
+            ax.set_xlim(ax.get_xlim())
+            ax.plot(ax.get_xlim(),[prctile_elev,prctile_elev],'k--',label=str(prctile)+' percentile',zorder=3)
+            ax.legend(fontsize=8)
+        if self.daily_maxs is not None:
+            ax.set_title('Daily Maximum Water Levels for '+self.input_file,fontsize=8)
+        else:
+            ax.set_title('Daily Minimum Water Levels for '+self.input_file,fontsize=8)
+        total_dt = self.__daily_extremes['time'].iloc[-1] - self.__daily_extremes['time'].iloc[0]
+        ticks = pd.date_range(self.__daily_extremes['time'].iloc[0],
+                              self.__daily_extremes['time'].iloc[-1],
+                              freq=total_dt/8)
+        ax.set_xlim(self.__daily_extremes['time'].iloc[0] - (total_dt/8/4),
+                    self.__daily_extremes['time'].iloc[-1] + (total_dt/8/4))
+        ax.set_xticks(ticks)
+        fig.autofmt_xdate()
+        fig.show()
+        return fig
+
+       
+def run(extremes_type, datum, data, datums, units, input_file):
+    datums['Input'] = 0
+    
+    # Get timestamps into a usable format #
+    data = data.rename(columns={data.columns[0]:'time',data.columns[1]:'val'})
+    data['time'] = pd.to_datetime(data['time'])
+    data = data.replace(-99999.99, np.nan)
+
+    # Put the data onto the threshold datum and onto MHHW #
+    data_dwant = pd.DataFrame({'time':data['time'],'val':data['val']-datums[datum]})
+
+    # Calc daily maxes #
+    data_dwant = data_dwant.set_index('time')
+    interval_hrs = (data_dwant.index[1] - data_dwant.index[0]).seconds/3600
+    n = data_dwant.groupby(data_dwant.index.date)['val'].size()
+    per_complete = n / (24 / interval_hrs) * 100
+    if extremes_type == 'max':
+        dmi = data_dwant.groupby(data_dwant.index.date)['val'].idxmax()
+    elif extremes_type == 'min':
+        dmi = data_dwant.groupby(data_dwant.index.date)['val'].idxmin()
+    dm = data_dwant.loc[dmi].reset_index()
+    dm = dm.rename(columns={'time':'time','val':'elevation'})
+    dm['completeness'] = per_complete.values
+
+    return Out(dm, extremes_type, datum, units, input_file)

tadc-2.3.5/tadc/filter_defs.py

@@ -0,0 +1,18 @@
+#
+# Filter definitions for Datums Calculator Tide picker
+#
+#
+from scipy.signal import butter, filtfilt
+
+#Butterworth digital filter design.
+def butter_lowpass(cutOff, fs, order=5):
+    nyq = 0.5 * fs
+    normalCutoff = cutOff / nyq
+    b, a = butter(order, normalCutoff, btype='low', analog = False)
+    return b, a
+
+def butter_lowpass_filter(data, cutOff, fs, order=4):
+    b, a = butter_lowpass(cutOff, fs, order=order)
+    y = filtfilt(b, a, data)
+    return y
+