ecopipeline 1.0.4__py3-none-any.whl → 1.0.5__py3-none-any.whl

ecopipeline/extract/__init__.py

@@ -1,4 +1,4 @@
-from .extract import get_noaa_data, json_to_df, extract_files, get_last_full_day_from_db, get_db_row_from_time, extract_new, csv_to_df, get_sub_dirs, msa_to_df, fm_api_to_df, small_planet_control_to_df, dent_csv_to_df, flow_csv_to_df, pull_egauge_data, egauge_csv_to_df, remove_char_sequence_from_csv_header, tb_api_to_df, skycentrics_api_to_df,get_OAT_open_meteo
+from .extract import get_noaa_data, json_to_df, extract_files, get_last_full_day_from_db, get_db_row_from_time, extract_new, csv_to_df, get_sub_dirs, msa_to_df, fm_api_to_df, small_planet_control_to_df, dent_csv_to_df, flow_csv_to_df, pull_egauge_data, egauge_csv_to_df, remove_char_sequence_from_csv_header, tb_api_to_df, skycentrics_api_to_df,get_OAT_open_meteo, licor_cloud_api_to_df
 __all__ = ["get_noaa_data", "json_to_df", "extract_files", "get_last_full_day_from_db", "get_db_row_from_time", 'extract_new', "csv_to_df", "get_sub_dirs", "msa_to_df", "fm_api_to_df",
            "small_planet_control_to_df","dent_csv_to_df","flow_csv_to_df","pull_egauge_data", "egauge_csv_to_df","remove_char_sequence_from_csv_header", "tb_api_to_df", "skycentrics_api_to_df",
-           "get_OAT_open_meteo"]
+           "get_OAT_open_meteo","licor_cloud_api_to_df"]

ecopipeline/extract/extract.py

@@ -862,6 +862,90 @@ def pull_egauge_data(config: ConfigManager, eGauge_ids: list, eGauge_usr : str,
 
     os.chdir(original_directory)
 
+def licor_cloud_api_to_df(config: ConfigManager, startTime: datetime = None, endTime: datetime = None, create_csv : bool = True) -> pd.DataFrame:
+    """
+    Connects to the LI-COR Cloud API to pull sensor data and returns a dataframe.
+
+    The function queries the LI-COR Cloud API for sensor data within the specified time range.
+    Each sensor's data is returned as a separate column in the dataframe, indexed by timestamp.
+
+    Parameters
+    ----------
+    config : ecopipeline.ConfigManager
+        The ConfigManager object that holds configuration data for the pipeline. The config manager
+        must contain the api_token and api_device_id (device serial number) for authentication
+        with the LI-COR Cloud API.
+    startTime : datetime
+        The start time for data extraction. If None, defaults to 28 hours before endTime.
+    endTime : datetime
+        The end time for data extraction. If None, defaults to the current time.
+    create_csv : bool
+        If True, saves the extracted data to a CSV file in the data directory (default True).
+
+    Returns
+    -------
+    pd.DataFrame:
+        Pandas DataFrame with sensor serial numbers as column headers and timestamps as the index.
+        The index is in UTC and may need to be converted to the appropriate timezone.
+        Returns an empty DataFrame if the API call fails.
+    """
+    df = pd.DataFrame()
+    api_device_id = config.api_device_id
+    if endTime is None:
+        endTime = datetime.now()
+    if startTime is None:
+        # 28 hours to ensure encapsulation of last day
+        startTime = endTime - timedelta(hours=28)
+
+    url = f'https://api.licor.cloud/v2/data'
+    token = config.api_token
+    params = {
+        'deviceSerialNumber': api_device_id,
+        'startTime': f'{int(startTime.timestamp())*1000}',
+        'endTime': f'{int(endTime.timestamp())*1000}'
+    }
+    # Headers
+    headers = {
+        'accept': 'application/json',
+        'Authorization': f'Bearer {token}'
+    }
+
+    try:
+        response = requests.get(url, headers=headers, params=params)
+        if response.status_code == 200:
+            response_json = response.json()
+            data = {}
+            if 'sensors' in response_json.keys():
+                for sensor in response_json['sensors']:
+                    sensor_id = sensor['sensorSerialNumber']
+                    for measurement in sensor.get('data', []):
+                        try:
+                            records = measurement.get('records', [])
+                            series = pd.Series(
+                                data={record[0]: _get_float_value(record[1]) for record in records}
+                            )
+                            data[sensor_id] = series
+                        except:
+                            print(f"Could not convert {sensor_id} values to floats.")
+            df = pd.DataFrame(data)
+            df.index = pd.to_datetime(df.index, unit='ms')
+            df = df.sort_index()
+        else:
+            print(f"Failed to make GET request. Status code: {response.status_code} {response.json()}")
+            df = pd.DataFrame()
+    except Exception as e:
+        traceback.print_exc()
+        print(f"An error occurred: {e}")
+        df = pd.DataFrame()
+    # save to file
+    if create_csv:
+        filename = f"{startTime.strftime('%Y%m%d%H%M%S')}.csv"
+        original_directory = os.getcwd()
+        os.chdir(config.data_directory)
+        df.to_csv(filename, index_label='time_pt')
+        os.chdir(original_directory)
+    return df
+
 def tb_api_to_df(config: ConfigManager, startTime: datetime = None, endTime: datetime = None, create_csv : bool = True, query_hours : float = 1,
                  sensor_keys : list = [], seperate_keys : bool = False, device_id_overwrite : str = None, csv_prefix : str = ""):
     """

ecopipeline/transform/transform.py

@@ -352,7 +352,7 @@ def convert_temp_resistance_type(df : pd.DataFrame, column_name : str, sensor_mo
     return df
 
 def estimate_power(df : pd.DataFrame, new_power_column : str, current_a_column : str, current_b_column : str, current_c_column : str,
-                 assumed_voltage : float = 208, power_factor : float = 1):
+                 assumed_voltage : float = 208, power_factor : float = 1) -> pd.DataFrame:
     """
     df: pd.DataFrame
         Pandas dataframe with minute-to-minute data

ecopipeline/utils/ConfigManager.py

@@ -7,6 +7,7 @@ from datetime import datetime
 import base64
 import hashlib
 import hmac
+import pandas as pd
 
 class ConfigManager:
     """
@@ -79,9 +80,10 @@ class ConfigManager:
                     self.api_pw = configure.get('data', 'api_pw')
                     self.api_device_id = configure.get('data','device_id')
                     configured_data_method = True
-                elif 'api_token' in configure['data'] and 'api_secret' in configure['data']:
+                elif 'api_token' in configure['data']:
                     self.api_token = configure.get('data', 'api_token')
-                    self.api_secret = configure.get('data', 'api_secret')
+                    if 'api_secret' in configure['data']:
+                        self.api_secret = configure.get('data', 'api_secret')
                     self.api_device_id = configure.get('data','device_id')
                     configured_data_method = True
             if not configured_data_method:
@@ -281,3 +283,14 @@ class ConfigManager:
             hashlib.sha1).digest())
         token = '{}:{}'.format(self.api_token, signature.decode())
         return token, date_str
+    
+    def get_ls_df(self, ls_file_name : str = 'load_shift.csv') -> pd.DataFrame:
+        full_ls_filename = f"{self.input_directory}load_shift.csv" 
+        if ls_file_name != "" and os.path.exists(full_ls_filename):
+            ls_df = pd.read_csv(full_ls_filename)
+            ls_df['startDateTime'] = pd.to_datetime(ls_df['date'] + ' ' + ls_df['startTime'])
+            ls_df['endDateTime'] = pd.to_datetime(ls_df['date'] + ' ' + ls_df['endTime'])
+            return ls_df
+        else:
+            print(f"The loadshift file '{full_ls_filename}' does not exist. Thus loadshifting will not be added to daily dataframe.")
+            return pd.DataFrame()

{ecopipeline-1.0.4.dist-info → ecopipeline-1.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecopipeline
-Version: 1.0.4
+Version: 1.0.5
 Summary: Contains functions for use in Ecotope Datapipelines
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License (GPL)

{ecopipeline-1.0.4.dist-info → ecopipeline-1.0.5.dist-info}/RECORD

@@ -1,15 +1,15 @@
 ecopipeline/__init__.py,sha256=pjC00JWsjVAhS0jUKHD-wyi4UIpTsWbIg9JaxLS1mlc,275
-ecopipeline/event_tracking/__init__.py,sha256=1saCNVWbcp7bwz1kXfKa2d8aUoGWNWvWSj7IJY4fzc8,219
-ecopipeline/event_tracking/event_tracking.py,sha256=LASkal4MgGLN7UzrAjbKw3eaM9JwKwt3YpkIraRSgiE,51172
-ecopipeline/extract/__init__.py,sha256=j_8-q_yrPRySwYyloMv5v2XQeYYyYfX0N-MW2ZDA4rg,775
-ecopipeline/extract/extract.py,sha256=MykzAchL_0LY0NG9TOAadpm5MSgjn7lPRI8AvSIMUBk,58530
+ecopipeline/event_tracking/__init__.py,sha256=91KN-WmYN6q1WbTJO-EE9QQUPCAQ1AbqH7krRsqaAug,402
+ecopipeline/event_tracking/event_tracking.py,sha256=TNuCNcr-5z9hEfu5CXyoMDvDyeBT05KB2X1U5PBtxeg,101489
+ecopipeline/extract/__init__.py,sha256=tGMph8ExJG_fYdGnlVbKfGwv8b4t8d7dcH2hekscpeg,822
+ecopipeline/extract/extract.py,sha256=OeNwxJ9uWZLJjtpm9_qzVpRRaqyPKjn39WlW4SpzDYE,62062
 ecopipeline/load/__init__.py,sha256=NLa_efQJZ8aP-J0Y5xx9DP7mtfRH9jY6Jz1ZMZN_BAA,292
 ecopipeline/load/load.py,sha256=PaSGWOZI0Xg44_SWN7htn2DPIAU_s8mOtCGibXq25tM,24614
 ecopipeline/transform/__init__.py,sha256=FjGcNpYNEYPdYQhogNRrQlKH2hGNNLv55jig1KaGaHY,2686
 ecopipeline/transform/bayview.py,sha256=TP24dnTsUD95X-f6732egPZKjepFLJgDm9ImGr-fppY,17899
 ecopipeline/transform/lbnl.py,sha256=EQ54G4rJXaZ7pwVusKcdK2KBehSdCsNo2ybphtMGs7o,33400
-ecopipeline/transform/transform.py,sha256=TaWFD7mrcTuLX-hmV8klyMFKFfEjzJI21FLkY37fjkY,57254
-ecopipeline/utils/ConfigManager.py,sha256=_9MZE9S-wOlQboAHzVk7VSrtxqR_lLu1hVJ-iulp4ag,13174
+ecopipeline/transform/transform.py,sha256=KVj3kkDa_dQOqRU4l4cHK01L0UPv3FTusQ_Dk2ez8RA,57270
+ecopipeline/utils/ConfigManager.py,sha256=E3YzdolFcRMVwxNk359Y0XVShqYquQ9otizPkkk9FU8,13880
 ecopipeline/utils/NOAADataDownloader.py,sha256=iC2nl_O4PS1KFrchcPXRZxshwZwUMSqXy6BQBUwnOUU,20927
 ecopipeline/utils/__init__.py,sha256=7dT3tP6SMK4uBW6NBmQ8i6LaNTTuV6fpAZToBBlJ904,62
 ecopipeline/utils/unit_convert.py,sha256=VFh1we2Y8KV3u21BeWb-U3TlZJXo83q5vdxxkpgcuME,3064
@@ -18,8 +18,8 @@ ecopipeline/utils/pkls/tasseron_resistance_to_temp_3.pkl,sha256=9UpCZ3rSu0mU4LoT
 ecopipeline/utils/pkls/tasseron_temp_to_resistance_2.pkl,sha256=Uq6I2dl5GcR5wb5QxurgDP4A2D4-N3neDL3BKtx53A4,2047
 ecopipeline/utils/pkls/veris_resistance_to_temp_3.pkl,sha256=CVbUWJvOQXg2nZ-0GP9FWtU-ffMGcwg3ok5q669bmf8,1472
 ecopipeline/utils/pkls/veris_temp_to_resistance_2.pkl,sha256=JiEp4SxR9eq-olKd8TKAG37iHMscJE_2SSHizGqBdno,1472
-ecopipeline-1.0.4.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ecopipeline-1.0.4.dist-info/METADATA,sha256=wE8t_wMfNclwSkN2kFK5mqazOXqvuI2VHqfMgrK1CxU,2363
-ecopipeline-1.0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ecopipeline-1.0.4.dist-info/top_level.txt,sha256=WOPFJH2LIgKqm4lk2OnFF5cgVkYibkaBxIxgvLgO7y0,12
-ecopipeline-1.0.4.dist-info/RECORD,,
+ecopipeline-1.0.5.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ecopipeline-1.0.5.dist-info/METADATA,sha256=eU8B5fLOWV_TQimqs2Ws-PgTZt88XRy8xgAmh9Dn5OQ,2363
+ecopipeline-1.0.5.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+ecopipeline-1.0.5.dist-info/top_level.txt,sha256=WOPFJH2LIgKqm4lk2OnFF5cgVkYibkaBxIxgvLgO7y0,12
+ecopipeline-1.0.5.dist-info/RECORD,,

{ecopipeline-1.0.4.dist-info → ecopipeline-1.0.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.1)
 Root-Is-Purelib: true
 Tag: py3-none-any