pycoustic 0.1.3__tar.gz → 0.1.5__tar.gz

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

@@ -1,13 +1,11 @@
 Metadata-Version: 2.3
 Name: pycoustic
-Version: 0.1.3
+Version: 0.1.5
 Summary: 
 Author: thumpercastle
 Author-email: tony.ryb@gmail.com
-Requires-Python: >=3.10,<4.0
+Requires-Python: >=3.12,<4.0
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: numpy (==2.2.6)
@@ -21,7 +19,7 @@ Description-Content-Type: text/markdown
 pycoustic is a Python-based toolkit designed to assist acoustic consultants and engineers in analyzing noise survey data. The library provides various tools and utilities for processing, interpreting, and visualizing noise measurements.
 
 ## Requirements
-This toolkit was written in Python 3.12. See the pyrpoject.toml for the latest dependencies.
+This toolkit was written in Python 3.12. See the pyproject.toml file for the latest dependencies. We recommend using Poetry to manage the packages.
 
 ## Features
 - Import and process noise survey data from .csv files
@@ -41,23 +39,32 @@ Make sure your input data is in the correct format. See the file UA1_py.csv for
 - Column headers should be in the Tuple-like format as per the example csv files attached. The measurement index should be first, and the frequency band or weighting should be second. e.g. the LAeq column should have the header *"Leq A"*, the L90 column at 125 Hz should have the header *"L90 125"*, and so on.
 - Make sure you past your data and columns into a fresh csv tab. If you end up having to chop the data and delete columns or rows, repaste it into a fresh tab when it is ready to be presented to the toolkit. Failure to do so can result in a ValueError. See **Troubleshooting** below.
 - If you do use this toolkit, please attribute it appropriately, and carry out your own checks to ensure you are satisfied with the outputs. See **Terms of Use** below.
+
+### Installing the package
+pycoustic can be installed using pip. The pypi project page is here: https://pypi.org/project/pycoustic/
+
+In your command line or Powershell terminal, type
+```
+pip install pycoustic
+```
+
 ### Basic Workflow
 1. **Import the library**\
-   Import the library into your script or active console.
+   Import the library into your script or active Python console.
    ```
-   from pycoustic import*
+   import pycoustic as pc
    ```
 2. **Load Data**\
    A single measurement position can be loaded into a Log object.
    ```
-   log1 = Log(path="path/to/data_for_pos1.csv")
-   log2 = Log(path="path/to/data_for_pos2.csv")
+   log1 = pc.Log(path="path/to/data_for_pos1.csv")
+   log2 = pc.Log(path="path/to/data_for_pos2.csv")
    ```
 3. **Combine Data**\
    The data from multiple measurement positions can be combined together within a Survey object.
    First we need to create a Survey object, and then add each Log one at a time.
    ```
-   surv = Survey()
+   surv = pc.Survey()
    surv.add_log(data=log1, name="Position 1")
    surv.add_log(data=log2, name="Position 2")
    ```
@@ -72,15 +79,20 @@ Make sure your input data is in the correct format. See the file UA1_py.csv for
    **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_l90()
    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.lmax_spectra()
+      
+   ## 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.typical_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.
+   
    
 
 ### Other methods
@@ -101,3 +113,4 @@ This project is being shared under a [Creative Commons CC BY-NC-SA 4.0 Licence](
 Attribution — You must give appropriate credit , provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
 NonCommercial — You may not use the material for commercial purposes.
 ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
+

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

@@ -3,7 +3,7 @@
 pycoustic is a Python-based toolkit designed to assist acoustic consultants and engineers in analyzing noise survey data. The library provides various tools and utilities for processing, interpreting, and visualizing noise measurements.
 
 ## Requirements
-This toolkit was written in Python 3.12. See the pyrpoject.toml for the latest dependencies.
+This toolkit was written in Python 3.12. See the pyproject.toml file for the latest dependencies. We recommend using Poetry to manage the packages.
 
 ## Features
 - Import and process noise survey data from .csv files
@@ -23,23 +23,32 @@ Make sure your input data is in the correct format. See the file UA1_py.csv for
 - Column headers should be in the Tuple-like format as per the example csv files attached. The measurement index should be first, and the frequency band or weighting should be second. e.g. the LAeq column should have the header *"Leq A"*, the L90 column at 125 Hz should have the header *"L90 125"*, and so on.
 - Make sure you past your data and columns into a fresh csv tab. If you end up having to chop the data and delete columns or rows, repaste it into a fresh tab when it is ready to be presented to the toolkit. Failure to do so can result in a ValueError. See **Troubleshooting** below.
 - If you do use this toolkit, please attribute it appropriately, and carry out your own checks to ensure you are satisfied with the outputs. See **Terms of Use** below.
+
+### Installing the package
+pycoustic can be installed using pip. The pypi project page is here: https://pypi.org/project/pycoustic/
+
+In your command line or Powershell terminal, type
+```
+pip install pycoustic
+```
+
 ### Basic Workflow
 1. **Import the library**\
-   Import the library into your script or active console.
+   Import the library into your script or active Python console.
    ```
-   from pycoustic import*
+   import pycoustic as pc
    ```
 2. **Load Data**\
    A single measurement position can be loaded into a Log object.
    ```
-   log1 = Log(path="path/to/data_for_pos1.csv")
-   log2 = Log(path="path/to/data_for_pos2.csv")
+   log1 = pc.Log(path="path/to/data_for_pos1.csv")
+   log2 = pc.Log(path="path/to/data_for_pos2.csv")
    ```
 3. **Combine Data**\
    The data from multiple measurement positions can be combined together within a Survey object.
    First we need to create a Survey object, and then add each Log one at a time.
    ```
-   surv = Survey()
+   surv = pc.Survey()
    surv.add_log(data=log1, name="Position 1")
    surv.add_log(data=log2, name="Position 2")
    ```
@@ -54,15 +63,20 @@ Make sure your input data is in the correct format. See the file UA1_py.csv for
    **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_l90()
    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.lmax_spectra()
+      
+   ## 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.typical_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.
+   
    
 
 ### Other methods
@@ -82,4 +96,4 @@ You may use this toolkit subject to the licence conditions below. For clarity, y
 This project is being shared under a [Creative Commons CC BY-NC-SA 4.0 Licence](https://creativecommons.org/licenses/by-nc-sa/4.0/).
 Attribution — You must give appropriate credit , provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
 NonCommercial — You may not use the material for commercial purposes.
-ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
+ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

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

@@ -1,12 +1,12 @@
 [tool.poetry]
 name = "pycoustic"
-version = "0.1.3"
+version = "0.1.5"
 description = ""
 authors = ["thumpercastle <tony.ryb@gmail.com>"]
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = ">=3.12, <4.0"
 pandas = "2.2.3"
 numpy = "2.2.6"
 openpyxl = "3.1.5"