eqcctpro 0.6.1__py3-none-any.whl → 0.6.3__py3-none-any.whl

{eqcctpro-0.6.1.dist-info → eqcctpro-0.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eqcctpro
-Version: 0.6.1
+Version: 0.6.3
 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
@@ -25,7 +24,7 @@ Requires-Dist: tensorboard==2.15.2
 Requires-Dist: tensorboard-data-server==0.7.2
 Requires-Dist: silence-tensorflow==1.2.3
 Requires-Dist: scipy==1.15.1
-Requires-Dist: protobuf==4.25.6
+Requires-Dist: protobuf==4.25.8
 Requires-Dist: grpcio==1.70.0
 Requires-Dist: absl-py==2.1.0
 Requires-Dist: h5py==3.12.1
@@ -59,9 +58,9 @@ This method installs only the EQCCTPro package **without** the sample waveform d
 EQCCTPro **requires Python 3.10.14 or higher as well as minimum Tensorflow packages**. If you have a clean working environment, you can simply run `pip install eqcctpro`. However, if you have a nonclean environment, its highly recommended to create a new conda environment so that you can install the necessary packages safely with no issues. You can create a new conda environment with the correct Python version by using the following commands:
 
 ```sh
-[skevofilaxc] conda create --name yourenvironemntname python=3.10.14 -y
-[skevofilaxc] conda activate yourenvironemntname 
-[skevofilaxc] python3 --version
+conda create --name yourenvironemntname python=3.10.14 -y
+conda activate yourenvironemntname 
+python3 --version
 ```
 Expected output:
 ```
@@ -70,19 +69,19 @@ Python 3.10.14
 
 After activating your new conda environment, run the following command:  
 ```sh
-[skevofilaxc] pip install eqcctpro
+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.
 
 ```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
+mkdir my_work_directory
+cd my_work_directory
+git clone --depth 1 --filter=tree:0 https://github.com/ut-beg-texnet/eqcct.git --sparse
+cd eqcct
+git sparse-checkout set eqcctpro
 ```
 
 ---
@@ -92,33 +91,23 @@ This method sets up EQCCTPro **with a pre-created conda environment and sample w
 
 ### **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
+mkdir my_work_directory
+cd my_work_directory
+git clone --depth 1 --filter=tree:0 https://github.com/ut-beg-texnet/eqcct.git --sparse
+cd eqcct
+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
+conda env create -f environment.yml
+conda activate eqcctpro
 ```
 
-### **Step 3: Install EQCCTPro**
-After activating the environment, install the EQCCTPro package:
-```sh
-[skevofilaxc] 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/)
 
 ---
@@ -131,7 +120,7 @@ To understand how **EQCCTPro** works, it is **highly recommended** to use provid
 ### **Step 1: Unzip the Sample Wavefrom Data**
 After downloading the `.zip` file through the GitHub methods above, run:
 ```sh
-[skevofilaxc] unzip 230_stations_1_min_dt.zip
+unzip 230_stations_1_min_dt.zip
 ```
 ### **Step 2: Check and Understand the Directory Structure**
 The extracted data will contain a timechunk subdirectories, comprised of multiple station directories:
@@ -385,7 +374,7 @@ the trial data will be available and can be used to identify the optimal input p
 
 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 +423,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].
@@ -466,8 +455,9 @@ The following input parameters need to be configurated for **EvaluateSystem** to
   - 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 
+  - 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 `set_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.3.dist-info/RECORD

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

{eqcctpro-0.6.1.dist-info → eqcctpro-0.6.3.dist-info}/WHEEL

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

eqcctpro-0.6.1.dist-info/RECORD

@@ -1,5 +0,0 @@
-eqcctpro/__init__.py,sha256=JK27ZrLxVDNHsdorp7UAislI8haH23rZhnEivVM7hgA,141
-eqcctpro-0.6.1.dist-info/METADATA,sha256=VCY3roBm7hSF0snfHiL5mMDdgmVK0ky2a1aC8xjmRUQ,31847
-eqcctpro-0.6.1.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-eqcctpro-0.6.1.dist-info/top_level.txt,sha256=u0cu2JdF7Z0ob7y4XdUCLoSGp_xOudAYz-fbsQ-B1yY,9
-eqcctpro-0.6.1.dist-info/RECORD,,