eqcctpro 0.4.1__py3-none-any.whl → 0.4.3__py3-none-any.whl

{eqcctpro-0.4.1.dist-info → eqcctpro-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: eqcctpro
-Version: 0.4.1
+Version: 0.4.3
 Description-Content-Type: text/markdown
 Requires-Dist: numpy==1.26.4
 Requires-Dist: pandas==2.2.3
@@ -39,27 +39,56 @@ EQCCTPro is a high-performace seismic event detection and processing framework t
 - Efficient handling of large-scale seismic data
 
 ## Installation
-To install the necessary dependencies, create a conda environment using:
+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)
 
+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.
+
+However, if you wish to install **only the EQCCTPro Python package and use it out of the box** (method 1), run:
 ```sh
-[skevofilaxc] conda env create -f environment.yml
-[skevofilaxc] conda activate eqcctpro
+**`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: 
+```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)
+[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: 
+
+```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
 ```
 
-You can get the `environment.yml` file from the `eqcct` repository. You can download the entire eqcct repository or download only the `eqcctpro` repository using the following command: 
+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). 
 
+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: 
 ```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
+[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: 
+
+After creating and activating the conda environment, install the **EQCCTPro Python package** using the following command: 
 ```sh
 [skevofilaxc] pip install eqcctpro
 ```
-More information on the package can be found at our PyPi project link [eqcctpro](https://pypi.org/project/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. 
@@ -299,7 +328,7 @@ Both **OptimalCPUConfigurationFinder** and **OptimalGPUConfigurationFinder** eac
 
 1. **`find_best_overall_usecase`**
   - Returns the best overall usecase configuration 
-    - Uses middel 50% of CPUs for moderate, balanced CPU usage, with the maximum amount of stations processed with the minimum runtime 
+    - Uses middle 50% of CPUs for moderate, balanced CPU usage, with the maximum amount of stations processed with the minimum runtime 
 2. **`find_optimal_for`**
   - Return the paralleliztion configurations (EX. concurrent predictions, intra/inter thread counts, vram, etc.) for a given number of CPU(s)/GPU(s) and stations
     - Enables users to quickly identify which input parameters should be used for the given amount of resources and workload they have for the minimum runtime possible on their computer
@@ -336,5 +365,5 @@ The `environment.yml` file specifies the dependencies required to run EQCCTPro.
 EQCCTPro is provided under an open-source license. See LICENSE for details.
 
 ## Contact
-For inquiries or issues, please contact constantinos.skevofilax@austin.utexas.edu.
+For inquiries or issues, please contact constantinos.skevofilax@austin.utexas.edu or victor.salles@beg.utexas.edu.
 

eqcctpro-0.4.3.dist-info/RECORD

@@ -0,0 +1,5 @@
+eqcctpro/__init__.py,sha256=JK27ZrLxVDNHsdorp7UAislI8haH23rZhnEivVM7hgA,141
+eqcctpro-0.4.3.dist-info/METADATA,sha256=8eqWW6sZA3jryXFPqqr6pHLjAauzIoNto7rJQUWgQnI,20949
+eqcctpro-0.4.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+eqcctpro-0.4.3.dist-info/top_level.txt,sha256=u0cu2JdF7Z0ob7y4XdUCLoSGp_xOudAYz-fbsQ-B1yY,9
+eqcctpro-0.4.3.dist-info/RECORD,,

eqcctpro-0.4.1.dist-info/RECORD

@@ -1,5 +0,0 @@
-eqcctpro/__init__.py,sha256=JK27ZrLxVDNHsdorp7UAislI8haH23rZhnEivVM7hgA,141
-eqcctpro-0.4.1.dist-info/METADATA,sha256=k-sQCltdzJcX3TtDiPH-Fr2GEiSwPTKk6xYopcQn-_A,18996
-eqcctpro-0.4.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-eqcctpro-0.4.1.dist-info/top_level.txt,sha256=u0cu2JdF7Z0ob7y4XdUCLoSGp_xOudAYz-fbsQ-B1yY,9
-eqcctpro-0.4.1.dist-info/RECORD,,