Skip to content

Update README for Anaconda usage #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Riviss wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README for Anaconda usage #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rrelocation

This repository contains scripts for cross‑correlating seismic waveforms and performing relative relocation using the GrowClust3D software. The code was adapted for internal use and expects data in specific directory structures.
This repository contains scripts for cross‑correlating seismic waveforms and performing relative relocation using the `GrowClust3D.jl` package. The code was adapted for internal use and expects data in specific directory structures. `GrowClust3D.jl` is the Julia implementation of the original GrowClust algorithm.

## Repository Layout

Expand All @@ -17,7 +17,7 @@ Key Python scripts now live in `src/`:
- `create_growclust_files_after_cc.py` – build `evlist.txt`, `stlist.txt` and `xcordata.txt` files for GrowClust.
- `create_relocation_files.py` – chunked cross‑correlation workflow that limits memory use.

The `scripts/` folder contains the Julia relocation script (`run_growclust3D.jl` and its multi‑process variant) and a helper shell script `run_relocation.sh` which loops over cluster directories.
The `scripts/` folder contains the Julia relocation script (`run_growclust3D.jl` and its multi‑process variant) and a helper shell script `run_relocation.sh` which loops over cluster directories. These scripts call the `GrowClust3D.jl` package, a Julia port of the original GrowClust relocation algorithm.

## Usage

Expand All @@ -41,11 +41,11 @@ Edit the paths at the top of each script to match your data layout before runnin

## Installation

Create a virtual environment and install dependencies:
We recommend installing the Python dependencies inside an Anaconda environment:

```bash
python -m venv .venv
source .venv/bin/activate
conda create -n rreloc python=3.8
conda activate rreloc
pip install -r requirements.txt
```

Expand Down