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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: eqcctpro
-Version: 0.4.7
+Version: 0.4.8
 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/
@@ -55,14 +55,8 @@ It is **highly recommended** that first-time users pull the `EQCCTPro` folder, w
 ## **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
-```
-
-### **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:
+### **Step 1: Create a Clean Conda Environment for the Install**
+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
@@ -74,13 +68,14 @@ Expected output:
 Python 3.10.14
 ```
 
-Now, reinstall EQCCTPro:
+After activating your new conda environment, run the following command:  
 ```sh
 [skevofilaxc] 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. 
 
 ### **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.
+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
@@ -350,6 +345,17 @@ The following input parameters need to be configurated for **EvaluateSystem** to
   - Allows for specific allocation and limitation of CPUs for a given EQCCTPro process 
     - "I want this program to run only on these specific cores." 
   - Must be at least 1 CPU if using GPUs (Ray needs CPUs to manage the Raylets (concurrent tasks), however the processing of the waveform is done on the GPU)
+- **`starting_amount_of_stations (int)`: default = 1** 
+  - For evaluating your system, you have the option to set a starting amount of stations you want to use in the test
+  - By default, the test will start using 1 station but now is configurable 
+- **`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
+- **`min_cpu_amount (int)`: default = 1**
+  - 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
 - **`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 
@@ -357,6 +363,7 @@ 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**
 After running **EvalutateSystem**, you can use either the **OptimalCPUConfigurationFinder** or the **OptimalGPUConfigurationFinder** determine the best CPU or GPU configurations (respectively) for your specific usecase:

eqcctpro-0.4.8.dist-info/RECORD

@@ -0,0 +1,5 @@
+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,,

eqcctpro-0.4.7.dist-info/RECORD

@@ -1,5 +0,0 @@
-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,,