Skip to content

Commit 00eb4d7

Browse files
committed
Add instructions on setting up condor env
1 parent 92abb69 commit 00eb4d7

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,43 @@ Subclasses the Dask Gateway client to launch dask clusters in Kubernetes, but
44
with HTCondor workers. This is a fork of the ingenious original idea by Maria
55
Acosta at Fermilab as part of their Elastic Analysis Facility project.
66

7+
## ICRN Quick Start
8+
As a user of the Illinois Computes Research Notebooks environment, you will use
9+
conda to set up the Condor tools and install this library. Create the following
10+
conda.yaml file:
11+
12+
```yaml
13+
name: dask-gateway
14+
channels:
15+
- conda-forge
16+
- defaults
17+
dependencies:
18+
- python=3.11
19+
- htcondor
20+
- pip
21+
- pip:
22+
- ncsa-htcdaskgateway>=1.0.2
23+
```
24+
25+
From a Jupyter terminal window create the conda environment with:
26+
27+
```bash
28+
conda env create -f conda.yaml
29+
conda activate dask-gateway
30+
```
31+
32+
Now you can use the `setup_condor` script to set up the HTCondor tools. This will request your
33+
Illinois password and attempt to log into the HTCondor login node and execute a command that
34+
generates a token file. This token file is used by the HTCondor tools to authenticate
35+
with the HTCondor cluster. The script will put the token in your `~/.condor/tokens.d` directory.
36+
37+
It will also write appropriate condor_config settings to the conda environment's condor directory.
38+
39+
When complete, you should be able to view the condor queue from an ICRN terminal with
40+
```bash
41+
condor_q
42+
```
43+
744
## How it Works
845

946
This is a drop-in replacement for the official Dask Gateway client. It keeps the

0 commit comments

Comments
 (0)