eqcctpro 0.4.6__py3-none-any.whl → 0.4.7__py3-none-any.whl

{eqcctpro-0.4.6.dist-info → eqcctpro-0.4.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: eqcctpro
-Version: 0.4.6
+Version: 0.4.7
 Summary: EQCCTPro: A powerful seismic event detection toolkit
 Author-email: Constantinos Skevofilax <constantinos.skevofilax@austin.utexas.edu>, Victor Salles <victor.salles@beg.utexas.edu>
 Project-URL: Homepage, https://pypi.org/project/eqcctpro/
@@ -31,40 +31,56 @@ Requires-Dist: absl-py==2.1.0
 Requires-Dist: h5py==3.12.1
 Requires-Dist: pynvml==12.0.0
 
-# EQCCTPro: powerful seismic event detection toolkit
+# **EQCCTPro: powerful seismic event detection toolkit**
 
-EQCCTPro is a high-performace seismic event detection and processing framework that leverages EQCCT to process seismic data efficiently. It enables users to fully leverage the computational ability of their computing resources for maximum performance for simultaneous seismic waveform processing, achieving real-time performance by identifying and utilizing the optimal computational configurations for their hardware. More information about the development, capabilities, and real-world applications about EQCCTPro can be read about in our research publication here.  
+EQCCTPro is a high-performace seismic event detection and processing framework that leverages DL-pickers, like EQCCT, to process seismic data efficiently. It enables users to fully leverage the computational ability of their computing resources for maximum performance for simultaneous seismic waveform processing, achieving real-time performance by identifying and utilizing the optimal computational configurations for their hardware. More information about the development, capabilities, and real-world applications about EQCCTPro can be read about in our research publication here.  
 
-## Features
+## **Features**
 - Supports both CPU and GPU execution
 - Configurable parallelism execution for optimized performance
 - Includes tools for evaluating system performance for optimal usecase configurations
 - Automatic selection of best-usecase configurations
 - Efficient handling of large-scale seismic data
 
-## Installation
-To install `EQCCTPro`, there are two installation approaches: 
-1. Install **EQCCTPro** out the box with no sample waveform data to test the application with (experts)
-2. Install **EQCCTPro** with the sample waveform data as provided from the Github folder (first-time users)
+# **Installation Guide**
+There are **two installation methods** for EQCCTPro:
 
-It is **highly** recommended you pull the `EQCCTPro` folder to gain access to the sample waveform data and code to help you get acquainted with **EQCCTPro** and its capabilites.
+1. **Method 1: Install EQCCTPro out of the box** (for experienced users)
+2. **Method 2: Install EQCCTPro with sample waveform data** (recommended for first-time users)
 
-However, if you wish to install **only the EQCCTPro Python package and use it out of the box** (method 1), run:
+It is **highly recommended** that first-time users pull the `EQCCTPro` folder, which includes sample waveform data and code to help get acquainted with **EQCCTPro**.
+
+---
+
+## **Method 1: Install EQCCTPro (No Sample Data)**
+This method installs only the EQCCTPro package **without** the sample waveform data.
+
+### **Step 1: Install EQCCTPro**
+Run the following command:
 ```sh
 pip install eqcctpro
 ```
-**You must have at least Python verison 3.10.14 for the application to run**. 
 
-You can install Python 3.10.14 using either traditional methods or do the following commands: 
+### **Step 2: Ensure Python 3.10.14 is Installed**
+EQCCTPro **requires Python 3.10.14 or higher**. If you don’t have it installed, you can create a conda environment with the correct Python version:
+
 ```sh
 [skevofilaxc] conda create --name yourenvironemntname python=3.10.14 -y
 [skevofilaxc] conda activate yourenvironemntname 
 [skevofilaxc] python3 --version
-Python 3.10.14 (it should return)
+```
+Expected output:
+```
+Python 3.10.14
+```
+
+Now, reinstall EQCCTPro:
+```sh
 [skevofilaxc] pip install eqcctpro
 ```
-You will have access to **EQCCTPro** and its capabilities, however, it is **highly** recommended you pull the `EQCCTPro` folder to gain access to the sample waveform data to help you get acquainted with **EQCCTPro's** functionality. 
-You can pull the `EQCCTPro` folder by running the following commands: 
+
+### **Step 3 (Optional): Pull the EQCCTPro Folder**
+Although not required, **it is highly recommended** to pull the `EQCCTPro` folder to gain access to sample waveform data.
 
 ```sh
 [skevofilaxc] mkdir my_work_directory
@@ -74,62 +90,94 @@ You can pull the `EQCCTPro` folder by running the following commands:
 [skevofilaxc] git sparse-checkout set eqcctpro
 ```
 
-If you wish to install **EQCCTPro** with the sample waveform data as **originally intended for first-time users**, and or are having trouble installing Python 3.10.14, there has been a precreated conda environment under the `EQCCTPro` folder that will install the necessary packages
-and dependencies needed for **EQCCTPro** to run (method 2). 
+---
+
+## **Method 2: Install EQCCTPro with Sample Data (Recommended for First-Time Users)**
+This method sets up EQCCTPro **with a pre-created conda environment and sample waveform data**.
 
-You can pull the `EQCCTPro` folder, create the precreated conda environment, and activate it as originally intended for first-time users using the following commands: 
+### **Step 1: Clone the EQCCTPro Repository**
 ```sh
 [skevofilaxc] mkdir my_work_directory
 [skevofilaxc] cd my_work_directory
 [skevofilaxc] git clone --depth 1 --filter=tree:0 https://github.com/ut-beg-texnet/eqcct.git --sparse
 [skevofilaxc] cd eqcct
 [skevofilaxc] git sparse-checkout set eqcctpro
+```
+
+### **Step 2: Create and Activate the Conda Environment**
+A **pre-configured conda environment** is included in the repository to handle all dependencies.
+
+```sh
 [skevofilaxc] conda env create -f environment.yml
 [skevofilaxc] conda activate eqcctpro
 ```
 
-After creating and activating the conda environment, install the **EQCCTPro Python package** using the following command: 
+### **Step 3: Install EQCCTPro**
+After activating the environment, install the EQCCTPro package:
 ```sh
 [skevofilaxc] pip install eqcctpro
 ```
-The pip package will install the remaining packages needed for **EQCCTPro** to work. More information on the eqcctpro pip package can be found at our PyPi project link here [(EQCCTPro)](https://pypi.org/project/eqcctpro/).
 
-## Creating a Test Workspace Environment
-It's highly suggested to create a workspace environment to first understand how eqcctpro works. 
-Sample seismic waveform data from 50 TexNet stations have provided in the eqcctpro repository under the `sample_1_minute_data.zip` file. 
+This will install any remaining dependencies needed for **EQCCTPro**.
+
+---
+
+## **More Information**
+For additional details and package updates, visit the **EQCCTPro PyPI page**:  
+🔗 [EQCCTPro on PyPI](https://pypi.org/project/eqcctpro/)
+
+---
 
-After downloading the .zip file, either individually or through the git pull methods, run the following command to unzip it: 
+### **Using Sample Waveform Data**
+To understand how **EQCCTPro** works, it is **highly recommended** to use provided sample seismic waveform data as the data source when testing the package. 
+
+Sample seismic waveform data from 50 TexNet stations have provided in the repository under `sample_1_minute_data.zip`. 
+
+### **Step 1: Unzip the Sample Wavefrom Data**
+After downloading the `.zip` file through the GitHub methods above, run:
 ```sh
 [skevofilaxc] unzip sample_1_minute_data.zip
 ```
-It's contents will look like: 
+### **Step 2: Check and Understand the Directory Structure**
+The extracted data will contain multiple station directories:
 ```sh
 [skevofilaxc sample_1_minute_data]$ ls
 AT01  CF01  DG05  EF54  EF76   HBVL  MB09  MB21   MID02  ODSA  PB16  PB25  PB35  PB52  PH02  SM03  WB11
 BB01  CT02  DG09  EF63  FOAK4  HNDO  MB13  MB25   MID03  PB04  PB17  PB26  PB39  PB54  PL01  SMWD  WB12
 BP01  DB02  EF02  EF75  FW13   MB06  MB19  MID01  MO01   PB11  PB18  PB34  PB42  PECS  SM02  WB06
 ```
-Where each subdirectory is named after station code, and is made up of mSEED files of different poses: 
+Each subdirectory contains **mSEED** files of different waveform components:
 ```sh
 [skevofilaxc PB35]$ ls
 TX.PB35.00.HH1__20241215T115800Z__20241215T120100Z.mseed  TX.PB35.00.HHZ__20241215T115800Z__20241215T120100Z.mseed
 TX.PB35.00.HH2__20241215T115800Z__20241215T120100Z.mseed
 ```
-EQCCT only needs one pose for the detection to occur, however more poses allow for better detection of the direction of the P and S waves. 
+EQCCT (i.e., the ML model) requires at least one pose per station for detection, but using multiple poses enhances P and S wave directionality.
+
+You have successfully installed EQCCTPro and set up the required sample waveform dataset for testing.
 
-You are now set up for testing. 
-## Usage
+---
+### **Using EQCCTPro**
 There are three main capabilities of EQCCTPro: 
-1. Process mSEED data from singular or multiple seismic stations using either CPUs or GPUs 
-2. Evaluate your system to identify the optimal parallelization configurations needed to get the minimum runtime performance out of your system
-3. Identify and return back the optimal parallelization configurations for both specific and general-use usecases for both CPU (a) and GPU applications (b)
+1. **Process mSEED data from singular or multiple seismic stations using either CPUs or GPUs** 
+2. **Evaluate your system to identify the optimal parallelization configurations needed to get the minimum runtime performance out of your system**
+3. **Identify and return back the optimal parallelization configurations for both specific and general-use usecases for both CPU (a) and GPU applications (b)**
 
-These capabilities are achieved by the following functions in order respect to the above descriptions: 
-**EQCCTMSeedRunner (1)**, **EvaluateSystem (2)**, **OptimalCPUConfigurationFinder (3a)**, **OptimalGPUConfigurationFinder (3b)**.
 
-### Processing mSEED data using EQCCTPro (EQCCTMSeedRunner) 
-To use EQCCTPro to process mSEED from various seismic stations, use the **EQCCTMSeedRunner** class. 
-**EQCCTMSeedRunner** enables users to process multiple mSEED from a given input directory. The input directory is made up of station directories such as: 
+These capabilities are achieved using the following core functions:
+
+- **EQCCTMSeedRunner** (for processing mSEED data)
+
+- **EvaluateSystem** (for system evaluation)
+
+- **OptimalCPUConfigurationFinder** (for CPU configuration optimization)
+
+- **OptimalGPUConfigurationFinder** (for GPU configuration optimization)
+
+---
+### **Processing mSEED data using EQCCTPro (EQCCTMSeedRunner)** 
+To process mSEED from various seismic stations, use the **EQCCTMSeedRunner** class. 
+**EQCCTMSeedRunner** enables users to process multiple mSEED from a given input directory, which consists of station directories formatted as follows:
 
 ```sh
 [skevofilaxc sample_1_minute_data]$ ls
@@ -137,7 +185,7 @@ AT01  CF01  DG05  EF54  EF76   HBVL  MB09  MB21   MID02  ODSA  PB16  PB25  PB35
 BB01  CT02  DG09  EF63  FOAK4  HNDO  MB13  MB25   MID03  PB04  PB17  PB26  PB39  PB54  PL01  SMWD  WB12
 BP01  DB02  EF02  EF75  FW13   MB06  MB19  MID01  MO01   PB11  PB18  PB34  PB42  PECS  SM02  WB06
 ```
-Where each subdirectory is named after station code. If you wish to use create your own input directory with custom information, **please follow the above naming convention.** Otherwise, EQCCTPro will **not** work. 
+Where each subdirectory is named after station code. If you wish to use create your own input directory with custom waveform mSEED files, **please follow the above naming convention.** Otherwise, EQCCTPro will **not** work. 
 
 Within each subdirectory, such as PB35, it is made up of mSEED files of different poses (EX. N, E, Z): 
 ```sh
@@ -231,7 +279,10 @@ eqcct_runner.run_eqcctpro()
   - List that defines which specific CPU cores that sched_setaffinity will allocate for executing the current EQCCTPro process.
   - Allows for specific allocation and limitation of CPUs for a given EQCCTPro process 
     - "I want this program to run only on these specific cores." 
-### Evaluating Your Systems Runtime Performance Capabilites
+
+---
+
+### **Evaluating Your Systems Runtime Performance Capabilites**
 To evaluate your system’s runtime performance capabilites for both your CPU(s) and GPU(s), the **EvaluateSystem** class allows you to autonomously evaluate your system:
 
 ```python
@@ -306,7 +357,8 @@ The following input parameters need to be configurated for **EvaluateSystem** to
   - List of GPU IDs on your computer you want to use if `mode = 'gpu'`
   - Non-existing GPU IDs will cause the code to exit 
 
-### Finding Optimal CPU/GPU Configurations
+---
+### **Finding Optimal CPU/GPU Configurations**
 After running **EvalutateSystem**, you can use either the **OptimalCPUConfigurationFinder** or the **OptimalGPUConfigurationFinder** determine the best CPU or GPU configurations (respectively) for your specific usecase:
 
 ```python
@@ -362,12 +414,12 @@ For **OptimalGPUConfigurationFinder.find_optimal_for()**, the function requires
 - **`station_count (int)`**
   - The number of station(s) you want to use in your application
 
-## Configuration
+## **Configuration**
 The `environment.yml` file specifies the dependencies required to run EQCCTPro. Ensure you have the correct versions installed by using the provided conda environment setup.
 
-## License
+## **License**
 EQCCTPro is provided under an open-source license. See LICENSE for details.
 
-## Contact
+## **Contact**
 For inquiries or issues, please contact constantinos.skevofilax@austin.utexas.edu or victor.salles@beg.utexas.edu.
 

eqcctpro-0.4.7.dist-info/RECORD

@@ -0,0 +1,5 @@
+eqcctpro/__init__.py,sha256=JK27ZrLxVDNHsdorp7UAislI8haH23rZhnEivVM7hgA,141
+eqcctpro-0.4.7.dist-info/METADATA,sha256=Qjzli5w8XTma5poz8X8lYOoTE9eSGwAhcJrBLqIusHE,21567
+eqcctpro-0.4.7.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+eqcctpro-0.4.7.dist-info/top_level.txt,sha256=u0cu2JdF7Z0ob7y4XdUCLoSGp_xOudAYz-fbsQ-B1yY,9
+eqcctpro-0.4.7.dist-info/RECORD,,

eqcctpro-0.4.6.dist-info/RECORD

@@ -1,5 +0,0 @@
-eqcctpro/__init__.py,sha256=JK27ZrLxVDNHsdorp7UAislI8haH23rZhnEivVM7hgA,141
-eqcctpro-0.4.6.dist-info/METADATA,sha256=fgPT7RLqvOJvQxZYgDnF8doCIg--4I8l4BwbeDW7sVU,21373
-eqcctpro-0.4.6.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-eqcctpro-0.4.6.dist-info/top_level.txt,sha256=u0cu2JdF7Z0ob7y4XdUCLoSGp_xOudAYz-fbsQ-B1yY,9
-eqcctpro-0.4.6.dist-info/RECORD,,