Skip to content

Commit deb9bd7

Browse files
committed
Clarify runtime-only env variables
1 parent acdd192 commit deb9bd7

2 files changed

Lines changed: 3 additions & 9 deletions

File tree

.env.example

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# Copy this file to `template/.env` and adjust values for your site.
2-
# Open OnDemand / scheduler settings
3-
OOD_CLUSTER=your_cluster_name
4-
OOD_QUEUE=your_queue_name
2+
# Runtime settings
53
OOD_RESULTS_URL_BASE=/pun/sys/dashboard/files/fs
6-
OOD_EMAIL_DOMAIN=@example.edu
7-
# OOD_EMAIL=user@example.edu
84
PFOLD_SCRIPT_FILE=/path/to/proteinfold/bin/start-alphafold2.sh
95
PFOLD_NATIVE_DEFAULT=-A your_project;-l select=1:ncpus=2:mem=4gb;-l walltime=48:00:00
106
PFOLD_NATIVE_GPU=-l select=1:ncpus=8:ngpus=1:mem=124gb;-l walltime=12:00:00

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,14 @@ To deploy ProteinFold on your own Open OnDemand instance:
3535

3636
2. **Configure for your site**:
3737
- Copy `.env.example` to `template/.env`.
38-
- Adjust the environment variables in `template/.env` for your cluster, queue, paths, email defaults, and output locations.
38+
- Adjust the runtime environment variables in `template/.env` for paths, caches, output locations, and other job-time settings.
39+
- Adjust the portal-side defaults at the top of the ERB files for cluster, queue, and other pre-submit settings.
3940
- If needed, set `PFOLD_NEXTFLOW_CONFIG` to your institutional Nextflow config file instead of editing `script.sh.erb`.
4041

4142
```
4243
# Example template/.env for ood-proteinfold
4344
44-
OOD_CLUSTER=your_cluster_name
45-
OOD_QUEUE=your_queue_name
4645
PFOLD_SCRIPT_FILE=/path/to/proteinfold/bin/start-alphafold2.sh
47-
OOD_EMAIL_DOMAIN=@example.edu
4846
PFOLD_NATIVE_DEFAULT=-A my_project;-l select=1:ncpus=2:mem=4gb;-l walltime=48:00:00
4947
PFOLD_NATIVE_GPU=-l select=1:ncpus=8:ngpus=1:mem=124gb;-l walltime=12:00:00
5048
PFOLD_RUN_ENVIRONMENT=prod

0 commit comments

Comments
 (0)