pycoustic 0.1.5__tar.gz → 0.1.7__tar.gz

{pycoustic-0.1.5 → pycoustic-0.1.7}/PKG-INFO

@@ -1,17 +1,19 @@
 Metadata-Version: 2.3
 Name: pycoustic
-Version: 0.1.5
+Version: 0.1.7
 Summary: 
 Author: thumpercastle
 Author-email: tony.ryb@gmail.com
-Requires-Python: >=3.12,<4.0
+Requires-Python: >=3.11.9,<4.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: numpy (==2.2.6)
 Requires-Dist: openpyxl (==3.1.5)
 Requires-Dist: pandas (==2.2.3)
+Requires-Dist: plotly (==6.1.2)
 Requires-Dist: requests (>=2.32.4,<3.0.0)
+Requires-Dist: streamlit (>=1.46.1,<2.0.0)
 Description-Content-Type: text/markdown
 
 # pycoustic - Toolkit for Analysing Noise Survey Data
@@ -70,6 +72,7 @@ pip install pycoustic
    ```
 4. **Analyse the Survey Data**
    The following are methods of the Survey() object representing the typical use cases for acoustic consultants in the UK.
+   
    ### Survey.resi_summary()
    This method provides a summary of the measurement data for residential projects, with a focus on typical assessment procedures in the UK.
    It presents A-weighted Leqs for each day and night period (and evenings, if enabled), as well as the nth-highest LAmax during each night-time period.
@@ -79,21 +82,26 @@ pip install pycoustic
    **lmax_n** *Int* *(default 10)* The nth-highest value to present.\
    **lmax_t** *Str* *(default "2min")* The time period T over which Lmaxes are presented. This must be equal to or longer than the period of the raw data.
    
-   ## Survey.modal_l90()
+   ## Survey.modal()
    Compute the modal L90 for daytime, evening (if enabled) and night-time periods. By default, this is set to T=60min for (23:00 to 07:00) periods, and T=15min for night-time (23:00 to 07:00) periods, as per BS 4142:2014.
       
+   ## Survey.counts()
+   Returns the L90 counts for daytime, evening and night-time periods. You can also choose to include other columns.
+
    ## Survey.lmax_spectra()
    Compute the Lmax Event spectra for the nth-highest Lmax during each night-time period.\
    **Note** the date presented alongside the Lmax event is actually the starting date of the night-time period. i.e. an Lmax event with a stamp of 20/12/2024 at 01:22 would actually have occurred on 21/12/2024 at 01:22. These stamps can also sometimes be out by a minute (known bug).
    
-   ## Survey.typical_leq_spectra()
+   ## Survey.leq_spectra()
    Compute the Leq spectra for daytime, evening (if enabled) and night-time periods. This will present the overall Leqs across the survey, not the Leq for each day.
-
+ 
    ## Survey.weather()
    Returns a pandas dataframe of the weather history over the course of your survey.
    Requires an **api_key** argument. This method makes a call to the OpenWeatherMap OneCall API (see https://openweathermap.org/api). You need to sign up and pass your API key as a string to the weather() method.
    
-   
+   ## Survey.weather_summary()
+   Returns a pandas dataframe summary of the weather history, comprising maximum, minimum and mean values.
+   You must have called Survey.weather() at least once before to get the summary.
 
 ### Other methods
 ### Known issues

{pycoustic-0.1.5 → pycoustic-0.1.7}/README.md

@@ -54,6 +54,7 @@ pip install pycoustic
    ```
 4. **Analyse the Survey Data**
    The following are methods of the Survey() object representing the typical use cases for acoustic consultants in the UK.
+   
    ### Survey.resi_summary()
    This method provides a summary of the measurement data for residential projects, with a focus on typical assessment procedures in the UK.
    It presents A-weighted Leqs for each day and night period (and evenings, if enabled), as well as the nth-highest LAmax during each night-time period.
@@ -63,21 +64,26 @@ pip install pycoustic
    **lmax_n** *Int* *(default 10)* The nth-highest value to present.\
    **lmax_t** *Str* *(default "2min")* The time period T over which Lmaxes are presented. This must be equal to or longer than the period of the raw data.
    
-   ## Survey.modal_l90()
+   ## Survey.modal()
    Compute the modal L90 for daytime, evening (if enabled) and night-time periods. By default, this is set to T=60min for (23:00 to 07:00) periods, and T=15min for night-time (23:00 to 07:00) periods, as per BS 4142:2014.
       
+   ## Survey.counts()
+   Returns the L90 counts for daytime, evening and night-time periods. You can also choose to include other columns.
+
    ## Survey.lmax_spectra()
    Compute the Lmax Event spectra for the nth-highest Lmax during each night-time period.\
    **Note** the date presented alongside the Lmax event is actually the starting date of the night-time period. i.e. an Lmax event with a stamp of 20/12/2024 at 01:22 would actually have occurred on 21/12/2024 at 01:22. These stamps can also sometimes be out by a minute (known bug).
    
-   ## Survey.typical_leq_spectra()
+   ## Survey.leq_spectra()
    Compute the Leq spectra for daytime, evening (if enabled) and night-time periods. This will present the overall Leqs across the survey, not the Leq for each day.
-
+ 
    ## Survey.weather()
    Returns a pandas dataframe of the weather history over the course of your survey.
    Requires an **api_key** argument. This method makes a call to the OpenWeatherMap OneCall API (see https://openweathermap.org/api). You need to sign up and pass your API key as a string to the weather() method.
    
-   
+   ## Survey.weather_summary()
+   Returns a pandas dataframe summary of the weather history, comprising maximum, minimum and mean values.
+   You must have called Survey.weather() at least once before to get the summary.
 
 ### Other methods
 ### Known issues

{pycoustic-0.1.5 → pycoustic-0.1.7}/pycoustic/__init__.py

@@ -1,3 +1,4 @@
 from .log import Log
 from .survey import Survey
-from .weather import WeatherHistory
+from .weather import WeatherHistory
+

{pycoustic-0.1.5 → pycoustic-0.1.7}/pycoustic/survey.py

@@ -3,10 +3,14 @@ import numpy as np
 from .weather import WeatherHistory
 
 
-DECIMALS=0
+DECIMALS=1
+
+pd.set_option('display.max_columns', None)
+pd.set_option('display.max_rows', None)
+
+#survey.leq_spectra() bug
+#TODO: C:\Users\tonyr\PycharmProjects\pycoustic\.venv1\Lib\site-packages\pycoustic\survey.py:287: FutureWarning: The behavior of pd.concat with len(keys) != len(objs) is deprecated. In a future version this will raise instead of truncating to the smaller of the two sequences combi = pd.concat(all_pos, axis=1, keys=["UA1", "UA2"])
 
-# pd.set_option('display.max_columns', None)
-# pd.set_option('display.max_rows', None)
 
 class Survey:
     """
@@ -19,6 +23,7 @@ class Survey:
     def __init__(self):
         self._logs = {}
         self._weather = WeatherHistory()
+        self._weatherhist = None
 
     def _insert_multiindex(self, df=None, super=None, name1="Position", name2="Date"):
         subs = df.index.to_list()   # List of subheaders (dates)
@@ -95,6 +100,7 @@ class Survey:
         :return: A dataframe presenting a summary of the Leq and Lmax values requested.
         """
         combi = pd.DataFrame()
+        period_headers = []
         if leq_cols is None:
             leq_cols = [("Leq", "A")]
         if max_cols is None:
@@ -194,6 +200,15 @@ class Survey:
         return combi
 
     def counts(self, cols=None, day_t="60min", evening_t="60min", night_t="15min"):
+        """
+        Returns counts for each time period. For example, this can return the number of L90 occurrences at each decibel
+        level for daytime and night-time periods.
+        :param cols: Which columns to consider. Default (L90, A).
+        :param day_t: Daytime averaging period. Default 60min.
+        :param evening_t: Evening average period. Default 60min.
+        :param night_t: Night-time average period. Default 15min.
+        :return: Returns a dataframe of counts for each time period.
+        """
         if cols is None:
             cols = [("L90", "A")]
         combi = pd.DataFrame()
@@ -222,6 +237,7 @@ class Survey:
             pos_df = self._insert_multiindex(pos_df, super=key)
             combi = pd.concat([combi, pos_df], axis=0)
         combi = self._insert_header(df=combi, new_head_list=period_headers, header_idx=0)
+        #TODO: This dataframe needs tidying.
         return combi
 
     def lmax_spectra(self, n=10, t="2min", period="nights"):
@@ -253,8 +269,6 @@ class Survey:
             combi = pd.concat(objs=[combi, summary], axis=0)
         return combi
 
-    # TODO: get_lowest_l90
-
     def leq_spectra(self, leq_cols=None):
         """
         Compute Leqs over daytime, evening and night-time periods.
@@ -263,7 +277,7 @@ class Survey:
         For all Leq columns, use ["Leq"]. For specific columns, use list of tuples [("Leq", "A"), ("Leq", 125)]
         :return: A dataframe with a continuous Leq computation across dates, for each time period.
         """
-        #TODO: C:\Users\tonyr\PycharmProjects\src\tests.py:674: FutureWarning: The behavior of pd.concat with len(keys) != len(objs) is deprecated. In a future version this will raise instead of truncating to the smaller of the two sequences combi = pd.concat(all_pos, axis=1, keys=["UA1", "UA2"])
+        #TODO: C:\Users\tonyr\PycharmProjects\pycoustic\tests.py:674: FutureWarning: The behavior of pd.concat with len(keys) != len(objs) is deprecated. In a future version this will raise instead of truncating to the smaller of the two sequences combi = pd.concat(all_pos, axis=1, keys=["UA1", "UA2"])
         all_pos = []
         if leq_cols is None:
             leq_cols = ["Leq"]
@@ -293,55 +307,23 @@ class Survey:
         ends = [self._logs[key].get_end() for key in self._logs.keys()]
         return min(starts), max(ends)
 
-    def weather(self, interval=6, api_key="", country="GB", postcode="WC1", tz="",):
-        start, end = self.get_start_end()
-        self._weather.reinit(start=start, end=end, interval=interval, api_key=api_key, country=country,
-                             postcode=postcode, tz=tz, units="metric")
-        self._weather.compute_weather_history()
-        return self._weather.get_weather_history()
+    def weather(self, interval=6, api_key=None, country="GB", postcode="WC1", tz="", recompute=False,
+                drop_cols=None):
+        if drop_cols is None:
+            drop_cols = ["sunrise", "sunset", "feels_like", "dew_point", "visibility"]
+        if self._weatherhist is not None and recompute==False:
+            return self._weatherhist
+        else:
+            if api_key is None:
+                raise ValueError("api_key is required")
+            start, end = self.get_start_end()
+            self._weather.reinit(start=start, end=end, interval=interval, api_key=api_key, country=country,
+                                 postcode=postcode, tz=tz, units="metric")
+            self._weatherhist = self._weather.compute_weather_history(drop_cols=drop_cols)
+        return self._weatherhist
 
-    # def typical_leq_spectra(self, leq_cols=None):
-    #     """
-    #     DEPRECATED 2025/06/05. Replaced by .leq_spectra() **TT**
-    #     Compute Leqs over daytime, evening and night-time periods.
-    #     This is an overall Leq, and does not group Leqs by date.
-    #     :param leq_cols: List of strings or List of Tuples.
-    #     For all Leq columns, use ["Leq"]. For specific columns, use list of tuples [("Leq", "A"), ("Leq", 125)]
-    #     :return: A dataframe with a continuous Leq computation across dates, for each time period.
-    #     """
-    #     combi = pd.DataFrame()
-    #     if leq_cols is None:
-    #         leq_cols = ["Leq"]
-    #     for key in self._logs.keys():
-    #         log = self._logs[key]
-    #         combined_list = []
-    #         # Day
-    #         days = log._get_period(data=log.get_antilogs(), period="days")
-    #         days = days[leq_cols].apply(lambda x: np.round(10*np.log10(np.mean(x)), DECIMALS))
-    #         #days.sort_index(inplace=True)
-    #         combined_list.append(days)
-    #         period_headers = ["Daytime" for i in range(len(leq_cols))]
-    #         # Evening
-    #         if log.is_evening():
-    #             evenings = log._get_period(data=log.get_antilogs(), period="evenings")
-    #             evenings = evenings[leq_cols].apply(lambda x: np.round(10*np.log10(np.mean(x)), DECIMALS))
-    #             evenings.sort_index(inplace=True)
-    #             combined_list.append(evenings)
-    #             for i in range(len(leq_cols)):
-    #                 period_headers.append("Evening")
-    #         # Night Leq
-    #         nights = log._get_period(data=log.get_antilogs(), period="nights")
-    #         nights = nights[leq_cols].apply(lambda x: np.round(10*np.log10(np.mean(x)), DECIMALS))
-    #         nights.sort_index(inplace=True)
-    #         combined_list.append(nights)
-    #         for i in range(len(leq_cols)):
-    #             period_headers.append("Night-time")
-    #         summary = pd.concat(objs=combined_list, axis=1)
-    #         summary = self._insert_multiindex(df=summary, super=key)
-    #         combi = pd.concat(objs=[combi, summary], axis=0)
-    #     new_head_dict = {}
-    #     for i in range(len(period_headers)):
-    #         new_head_dict[i] = period_headers[i]
-    #     combi.rename(columns=new_head_dict, inplace=True)
-    #     #combi = combi.transpose()
-    #     return combi
+    def weather_summary(self):
+        if self._weatherhist is None:
+            raise ValueError("No weather history available. Use Survey.weather() first.")
+        return pd.DataFrame([self._weatherhist.min(), self._weatherhist.max(), self._weatherhist.mean()],
+                            index=["Min", "Max", "Mean"]).drop(columns=["dt"]).round(decimals=1)

{pycoustic-0.1.5 → pycoustic-0.1.7}/pycoustic/tkgui.py

@@ -10,14 +10,14 @@ from tkinter import StringVar
 #import matplotlib
 #from matplotlib.backends.backend_tkagg import FigureCanvasTkAgg
 
-#from src import log  # Assuming log is an instance of a class with the required methods
+#from pycoustic import log  # Assuming log is an instance of a class with the required methods
 test = 0
 
 class Application(tk.Tk):
     
     def __init__(self):
         super().__init__()
-        self.title("src Log Viewer")
+        self.title("pycoustic Log Viewer")
         self.geometry("1200x800")
         import tkinter as tk
 

{pycoustic-0.1.5 → pycoustic-0.1.7}/pycoustic/weather.py

@@ -2,11 +2,10 @@ import requests
 import pandas as pd
 import datetime as dt
 
-test=0
 
 appid = ""
-with open("tests/openweather_app_id.txt") as f:
-    appid = f.readlines()[0]
+# with open("tests/openweather_app_id.txt") as f:
+#     appid = f.readlines()[0]
 
 w_dict = {
     "start": "2022-09-16 12:00:00",
@@ -18,6 +17,7 @@ w_dict = {
     "tz": "GB"
 }
 
+
 def test_weather_obj(weather_test_dict):
     hist = WeatherHistory(start=w_dict["start"], end=w_dict["end"], interval=w_dict["interval"],
                           api_key=w_dict["api_key"], country=w_dict["country"], postcode=w_dict["postcode"],
@@ -58,7 +58,6 @@ class WeatherHistory:
         base = "https://api.openweathermap.org/data/3.0/onecall/timemachine?"
         query = str(base + "lat=" + str(self._lat) + "&" + "lon=" + str(self._lon) + "&" + "units=" + self._units + \
                     "&" + "dt=" + str(timestamp) + "&" + "appid=" + self._api_key)
-        print(query)
         return query
 
     def _construct_timestamps(self):
@@ -71,28 +70,25 @@ class WeatherHistory:
 
     def _make_and_parse_api_call(self, query):
         response = requests.get(query)
-        print(response.json())
         # This drops some unwanted cols like lat, lon, timezone and tz offset.
         resp_dict = response.json()["data"][0]
         del resp_dict["weather"]    # delete weather key as not useful.
         # TODO: parse 'weather' nested dict.
         return resp_dict
 
-    def compute_weather_history(self):
+    def compute_weather_history(self, drop_cols):
         # construct timestamps
         timestamps = self._construct_timestamps()
         # make calls to API
         responses = []
         for ts in timestamps:
-            print(f"ts: {ts}")
             query = self._construct_api_call(timestamp=ts)
             response_dict = self._make_and_parse_api_call(query=query)
             responses.append(pd.Series(response_dict))
         df = pd.concat(responses, axis=1).transpose()
         for col in ["dt", "sunrise", "sunset"]:
             df[col] = df[col].apply(lambda x: dt.datetime.fromtimestamp(int(x)))  # convert timestamp into datetime
-        print(df)
-        self._hist = df
+        df.drop(columns=drop_cols, inplace=True)
         return df
 
     def get_weather_history(self):

{pycoustic-0.1.5 → pycoustic-0.1.7}/pyproject.toml

@@ -1,16 +1,18 @@
 [tool.poetry]
 name = "pycoustic"
-version = "0.1.5"
+version = "0.1.7"
 description = ""
 authors = ["thumpercastle <tony.ryb@gmail.com>"]
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = ">=3.12, <4.0"
+python = ">=3.11.9, <4.0"
 pandas = "2.2.3"
 numpy = "2.2.6"
 openpyxl = "3.1.5"
 requests = "^2.32.4"
+plotly = "6.1.2"
+streamlit = "^1.46.1"
 
 
 [build-system]