eqcctpro 0.4.8__py3-none-any.whl → 0.5.0__py3-none-any.whl

{eqcctpro-0.4.8.dist-info → eqcctpro-0.5.0.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.2
 Name: eqcctpro
-Version: 0.4.8
+Version: 0.5.0
 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/
-Project-URL: Repository, https://github.com/ut-beg-texnet/eqcctpro
-Project-URL: Issues, https://github.com/ut-beg-texnet/eqcctpro/issues
+Project-URL: Repository, https://github.com/ut-beg-texnet/eqcct/tree/main/eqcctpro
+Project-URL: Issues, https://github.com/ut-beg-texnet/eqcct/tree/main/eqcctpro/issues
 Project-URL: Documentation, https://github.com/ut-beg-texnet/eqcct/blob/main/eqcctpro/README.md
 Requires-Python: >=3.10.14
 Description-Content-Type: text/markdown
@@ -284,24 +284,50 @@ To evaluate your system’s runtime performance capabilites for both your CPU(s)
 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',
-    stations2use=2,
-    cpu_id_list=[0,1],
-    set_vram_mb=24750,
-    selected_gpus=[0]
+                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',
+                stations2use=2,
+                cpu_id_list=[0,1],
+                set_vram_mb=24750,
+                selected_gpus=[0]
 )
 eval_gpu.evaluate()
 ```
+
+```python
+from eqcctpro import EvaluateSystem
+
+eval_cpu = EvaluateSystem(
+                mode='cpu',
+                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',
+                stations2use=12,
+                cpu_id_list=range(87,102), 
+                starting_amount_of_stations=2, 
+                station_list_step_size=1,
+                min_cpu_amount=15,
+                min_conc_predictions=2,
+                conc_predictions_step_size=1)
+eval_cpu.evaluate()
+```
+
 **EvaluateSystem** will iterate through different combinations of CPU(s), Concurrent Predictions, and Workloads (stations), 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. 
@@ -356,6 +382,12 @@ The following input parameters need to be configurated for **EvaluateSystem** to
   - Is the minimum amount of CPUs you want to start your trials with 
   - By default, trials will start iterating with 1 CPU up to the maximum allocated 
   - Can now set a value as the starting point, such as 15 CPUs up to the maximum of for instance 25
+- **`min_conc_predictions (int)`: default = 1** 
+  - Is the minimum amount of concurrent 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].
+- **`conc_predictions_step_size (int)`: default = 1** 
+  - Is the concurrent predictions step size you want each trial iteration to iterate with 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]
 - **`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 

eqcctpro-0.5.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+eqcctpro/__init__.py,sha256=JK27ZrLxVDNHsdorp7UAislI8haH23rZhnEivVM7hgA,141
+eqcctpro-0.5.0.dist-info/METADATA,sha256=0AoLLn-1lNx2M8jThonwGVw-PvfeCuqP0Gkh2c4NRMg,24858
+eqcctpro-0.5.0.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+eqcctpro-0.5.0.dist-info/top_level.txt,sha256=u0cu2JdF7Z0ob7y4XdUCLoSGp_xOudAYz-fbsQ-B1yY,9
+eqcctpro-0.5.0.dist-info/RECORD,,

{eqcctpro-0.4.8.dist-info → eqcctpro-0.5.0.dist-info}/WHEEL

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

eqcctpro-0.4.8.dist-info/RECORD

@@ -1,5 +0,0 @@
-eqcctpro/__init__.py,sha256=JK27ZrLxVDNHsdorp7UAislI8haH23rZhnEivVM7hgA,141
-eqcctpro-0.4.8.dist-info/METADATA,sha256=LGJ-8Ybjlqz6JK9O_2zDj0XcV3AifWl1oSlSy52y6g0,23016
-eqcctpro-0.4.8.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-eqcctpro-0.4.8.dist-info/top_level.txt,sha256=u0cu2JdF7Z0ob7y4XdUCLoSGp_xOudAYz-fbsQ-B1yY,9
-eqcctpro-0.4.8.dist-info/RECORD,,