Skip to content

Add Julia instructions #2

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

Add Julia instructions #2

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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,25 @@ conda activate rreloc
pip install -r requirements.txt
```

## Running the Julia relocation script

The relocation routine itself is implemented in Julia using the
`GrowClust3D.jl` package. You will need a working Julia installation
and the package available in your Julia environment. A typical setup
looks like:

```bash
# install Julia packages (from the Julia REPL)
import Pkg; Pkg.add("GrowClust3D")

# run GrowClust with the provided control file
julia scripts/run_growclust3D.jl dawson.nllgrid3D.inp
```

Edit the `dawson.nllgrid3D.inp` control file or supply your own path if
needed. When running batch relocations `scripts/run_relocation.sh`
will execute the above command for each cluster directory.

## License

This project is licensed under the terms of the MIT License. See [LICENSE](LICENSE) for details.