eqcctpro 0.6.2__py3-none-any.whl → 0.6.4__py3-none-any.whl

{eqcctpro-0.6.2.dist-info → eqcctpro-0.6.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eqcctpro
-Version: 0.6.2
+Version: 0.6.4
 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/
@@ -13,7 +13,6 @@ Requires-Dist: numpy==1.26.4
 Requires-Dist: pandas==2.2.3
 Requires-Dist: matplotlib==3.10.0
 Requires-Dist: obspy==1.4.1
-Requires-Dist: progress==1.6
 Requires-Dist: psutil==6.1.1
 Requires-Dist: ray==2.42.1
 Requires-Dist: schedule==1.2.2
@@ -72,7 +71,7 @@ After activating your new conda environment, run the following command:
 ```sh
 pip install eqcctpro
 ```
-You will have access to EQCCTPro and its functionality. However you will not have immediate access to the provided sample waveform data to use for testing. Youcan pull the waveform data either by downloading the .zip file from the repository or by following step 3. 
+You will have access to EQCCTPro and its functionality. However you will not have immediate access to the provided sample waveform data to use for testing. You can pull the waveform data either by downloading the .zip file from the repository or by following step 3. 
 
 ### **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 for testing.
@@ -107,18 +106,8 @@ conda env create -f environment.yml
 conda activate eqcctpro
 ```
 
-### **Step 3: Install EQCCTPro**
-After activating the environment, install the EQCCTPro package:
-```sh
-pip install eqcctpro
-```
-
-This will install any remaining dependencies needed for **EQCCTPro**.
-
----
-
 ## **More Information**
-For additional details and package updates, visit the **EQCCTPro PyPI page**:  
+For additional package updates, continue to check either this repository or visit the **EQCCTPro PyPI page**:  
 🔗 [EQCCTPro on PyPI](https://pypi.org/project/eqcctpro/)
 
 ---
@@ -166,7 +155,7 @@ There are three main capabilities of EQCCTPro:
 
 These capabilities are achieved using the following core functions:
 
-- **EQCCTMSeedRunner** (for processing mSEED data)
+- **RunEQCCTPro** (for processing mSEED data)
 
 - **EvaluateSystem** (for system evaluation)
 
@@ -175,9 +164,9 @@ These capabilities are achieved using the following core functions:
 - **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:
+### **Processing mSEED data using EQCCTPro (RunEQCCTPro)** 
+To process mSEED from various seismic stations, use the **RunEQCCTPro** class. 
+**RunEQCCTPro** enables users to process multiple mSEED from a given input directory, which consists of station directories formatted as follows:
 
 ```sh
 [skevofilaxc 230_stations_1_min_dt]$ ls
@@ -210,12 +199,12 @@ 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.
 
-After setting up or utilizing the provided sample waveform directory, and install eqcctpro, import **EQCCTMseedRunner** as show below: 
+After setting up or utilizing the provided sample waveform directory, and install eqcctpro, import **RunEQCCTPro** as show below: 
 
 ```python
-from eqcctpro import EQCCTMSeedRunner
+from eqcctpro import RunEQCCTPro
 
-eqcct_runner = EQCCTMSeedRunner(
+eqcct_runner = RunEQCCTPro(
     use_gpu=False,
     intra_threads=1,
     inter_threads=1,
@@ -232,7 +221,7 @@ eqcct_runner = EQCCTMSeedRunner(
     best_usecase_config=True,
     csv_dir='/path/to/csv',
     selected_gpus=[0],
-    set_vram_mb=24750,
+    vram_mb=24750,
     specific_stations='AT01, BP01, DG05',
     start_time='2024-12-14 12:00:00',
     end_time='2024-12-15 12:00:00',
@@ -242,7 +231,7 @@ eqcct_runner = EQCCTMSeedRunner(
 eqcct_runner.run_eqcctpro()
 ```
 
-**EQCCTMseedRunner** has multiple input parameters that need to be configured and are defined below: 
+**RunEQCCTPro** has multiple input parameters that need to be configured and are defined below: 
 
 - **`use_gpu (bool)`: True or False** 
   - Tells Ray to use either the GPU(s) (True) or CPUs (False) on your computer to process the waveforms in the entire workflow
@@ -291,7 +280,7 @@ eqcct_runner.run_eqcctpro()
 - **`selected_gpus (list)`: default = None**
   - List of GPU IDs on your computer you want to use if `use_gpu = True`
   - None existing GPU IDs will cause the code to exit 
-- **`set_vram_mb (float)`**
+- **`vram_mb (float)`**
   - Value of the maximum amount of VRAM EQCCTPro can use 
   - Must be a real value that is based on your hardware's physical memory space, if it exceeds the space the code will break due to **OutOfMemoryError**
 - **`specific_stations (str)`: default = None**
@@ -324,28 +313,6 @@ eqcct_runner.run_eqcctpro()
 ### **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
-from eqcctpro import EvaluateSystem
-
-eval_gpu = EvaluateSystem(
-                mode='gpu',
-                intra_threads=1,
-                inter_threads=1,
-                input_dir='/path/to/mseed',
-                output_dir='/path/to/outputs',
-                log_filepath='/path/to/outputs/eqcctpro.log',
-                csv_dir='/path/to/csv',
-                P_threshold=0.001,
-                S_threshold=0.02,
-                p_model_filepath='/path/to/model_p.h5',
-                s_model_filepath='/path/to/model_s.h5',
-                cpu_id_list=[0,1],
-                set_vram_mb=24750,
-                selected_gpus=[0],
-                stations2use=2
-)
-eval_gpu.evaluate()
-```
 
 ```python
 from eqcctpro import EvaluateSystem
@@ -379,13 +346,36 @@ eval_cpu = EvaluateSystem(
 eval_cpu.evaluate()
 ```
 
+```python
+from eqcctpro import EvaluateSystem
+
+eval_gpu = EvaluateSystem(
+                mode='gpu',
+                intra_threads=1,
+                inter_threads=1,
+                input_dir='/path/to/mseed',
+                output_dir='/path/to/outputs',
+                log_filepath='/path/to/outputs/eqcctpro.log',
+                csv_dir='/path/to/csv',
+                P_threshold=0.001,
+                S_threshold=0.02,
+                p_model_filepath='/path/to/model_p.h5',
+                s_model_filepath='/path/to/model_s.h5',
+                cpu_id_list=[0,1],
+                vram_mb=24750,
+                selected_gpus=[0],
+                stations2use=2
+)
+eval_gpu.evaluate()
+```
+
 **EvaluateSystem** will iterate through different combinations of CPU(s), Concurrent Timechunk and Station Tasks, as well as GPU(s), and the amount of VRAM (MB) each Concurrent Prediction can use. 
 **EvaluateSystem** will take time, depending on the number of CPU/GPUs, the amount of VRAM available, and the total workload that needs to be tested. However, after doing the testing once for most if not all usecases, 
-the trial data will be available and can be used to identify the optimal input parallelization configurations for **EQCCTMSeedRunner** to use to get the maximum amount of processing out of your system in the shortest amonut of time. 
+the trial data will be available and can be used to identify the optimal input parallelization configurations for **RunEQCCTPro** to use to get the maximum amount of processing out of your system in the shortest amonut of time. 
 
 The following input parameters need to be configurated for **EvaluateSystem** to evaluate your system based on your desired utilization of EQCCTPro: 
 
-- **`mode (str)`**
+- **`eval_mode (str)`**
   - Can be either `cpu` or `gpu`
   - Tells `EvaluateSystem` which computing approach the trials should it iterate with
 - **`intra_threads (int)`: default = 1**
@@ -434,7 +424,7 @@ The following input parameters need to be configurated for **EvaluateSystem** to
 - **`station_list_step_size (int)`: default = 1** 
   - You can set a step size for the station list that is generated 
   - For example if the stepsize is set to 10 and you start with 50 stations with a max of 100, then your list would be: [50, 60, 70, 80, 80, 100]
-  - Using 1 will use the default step size of 1-10, then step size of 5 up to station2use
+  - Using 1 will use the default step size of 1-10, then step size of 5 up to stations2use
 - **`min_conc_stations (int)`: default = 1** 
   - Is the minimum amount of concurrent stations predictions you want each trial iteration to start with 
   - By default, if `min_conc_predictions` and `conc_predictions_step_size` are set to 1, a custom step size iteration will be applied to test the 50 sample waveforms. The sequence follows: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, n+5, 50].
@@ -465,9 +455,10 @@ The following input parameters need to be configurated for **EvaluateSystem** to
 - **`tmp_dir (str)`: default = 1** 
   - A temporary directory to store all temp files produced by EQCCTPro
   - Used to help ease system cleanup and to not write to system's default temporary directory 
-- **`set_vram_mb (float)`**
-  - Value of the maximum amount of VRAM EQCCTPro can use 
-  - Must be a real value that is based on your hardware's physical memory space, if it exceeds the space the code will break due to OutOfMemoryError 
+- **`vram_mb (float)`**
+  - Maximum amount of VRAM each Raylet can use (float).  
+  - Must be a real value that is based on your GPU's physical VRAM space, if it exceeds the space the code will break due to OutOfMemoryError 
+  - Good rule of thumb for calculating `vram_mb` = (GPU VRAM * .90 (to be safe)) / number_of_concurrent_station_predictions * number_of_concurrent_timechunk_predictions
 - **`selected_gpus (list)`: default = None**
   - List of GPU IDs on your computer you want to use if `mode = 'gpu'`
   - Non-existing GPU IDs will cause the code to exit 

eqcctpro-0.6.4.dist-info/RECORD

@@ -0,0 +1,5 @@
+eqcctpro/__init__.py,sha256=JK27ZrLxVDNHsdorp7UAislI8haH23rZhnEivVM7hgA,141
+eqcctpro-0.6.4.dist-info/METADATA,sha256=kUpXBT3BRBfi8LTzH0Lncc7m2BdUp3LHCPc0W4cGD0s,31502
+eqcctpro-0.6.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+eqcctpro-0.6.4.dist-info/top_level.txt,sha256=u0cu2JdF7Z0ob7y4XdUCLoSGp_xOudAYz-fbsQ-B1yY,9
+eqcctpro-0.6.4.dist-info/RECORD,,

eqcctpro-0.6.2.dist-info/RECORD

@@ -1,5 +0,0 @@
-eqcctpro/__init__.py,sha256=JK27ZrLxVDNHsdorp7UAislI8haH23rZhnEivVM7hgA,141
-eqcctpro-0.6.2.dist-info/METADATA,sha256=lAvGe6qc2skJvJ65-4cMjS_ad8PxCN93vBvglb8XDmc,31595
-eqcctpro-0.6.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-eqcctpro-0.6.2.dist-info/top_level.txt,sha256=u0cu2JdF7Z0ob7y4XdUCLoSGp_xOudAYz-fbsQ-B1yY,9
-eqcctpro-0.6.2.dist-info/RECORD,,