Skip to content

Commit 91eeb2c

Browse files
committed
Remove Nextstrain profiles
This is a comprehensive shift from --profile to --configfile, standardizing the preference started in "Remove my_profiles/" (2b88070) and already used by the "100k" workflow (which was misleadingly under "nextstrain_profiles"). Workflow-specific options are translated into command line arguments in the GitHub Actions workflow. Default options are retained in a default profile config, a practice used across other pathogen workflows.
1 parent 3b1c0e4 commit 91eeb2c

20 files changed

Lines changed: 29 additions & 44 deletions

File tree

.github/workflows/ci.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
test-build:
1212
uses: nextstrain/.github/.github/workflows/pathogen-repo-ci.yaml@v0
1313
with:
14-
build-args: all_regions -j 2 --profile nextstrain_profiles/nextstrain-ci
14+
build-args: all_regions -j 2 --configfile nextstrain_configs/gisaid/builds.yaml nextstrain_configs/ci/builds.yaml
1515

1616
test-cram:
1717
runs-on: ubuntu-latest

.github/workflows/rebuild-100k.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
--memory 12GiB \
2828
. \
2929
upload \
30-
--configfile nextstrain_profiles/100k/config-open.yaml \
30+
--configfile nextstrain_configs/100k/config-open.yaml \
3131
--config "${config[@]}" \
3232
--set-threads tree=2
3333
artifact-name: open-build-output

.github/workflows/rebuild-gisaid.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,6 @@ jobs:
5151
deploy \
5252
upload \
5353
--config "${config[@]}" \
54-
--profile nextstrain_profiles/nextstrain-gisaid \
54+
--configfile nextstrain_configs/gisaid/builds.yaml \
55+
--restart-times 2 \
5556
--set-threads tree=2

.github/workflows/rebuild-open.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,6 @@ jobs:
5252
deploy \
5353
upload \
5454
--config "${config[@]}" \
55-
--profile nextstrain_profiles/nextstrain-open \
55+
--configfile nextstrain_configs/open/builds.yaml \
56+
--restart-times 2 \
5657
--set-threads tree=2

docs/dev_docs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ We do not release new minor versions for new features, but you should document n
2929
The "core" nextstrain builds consist of a global analysis and six regional analyses, performed independently for GISAID data and open data (currently open data is GenBank data).
3030
Stepping back, the process can be broken into three steps:
3131
1. Ingest and curation of raw data. This is performed by the [ncov-ingest](https://github.com/nextstrain/ncov-ingest/) repo and resulting files are uploaded to S3 buckets.
32-
2. Phylogenetic builds, which start from the files produced by the previous step. This is performed by the profiles `nextstrain_profiles/nextstrain-open` and `nextstrain_profiles/nextstrain-gisaid`. The resulting files are uploaded to S3 buckets by the `upload` rule.
32+
2. Phylogenetic builds, which start from the files produced by the previous step. These are configured by files under `nextstrain_configs`. Shared Snakemake execution defaults are defined in `profiles/default/config.yaml`. The resulting files are uploaded to S3 buckets by the `upload` rule.
3333

3434

3535
### Manually running phylogenetic builds
3636

3737
To run these pipelines locally, without uploading the results:
3838
```sh
39-
nextstrain build . all --profile nextstrain_profiles/nextstrain-open
40-
nextstrain build . all --profile nextstrain_profiles/nextstrain-gisaid
39+
nextstrain build . all --configfile nextstrain_configs/open/builds.yaml
40+
nextstrain build . all --configfile nextstrain_configs/gisaid/builds.yaml
4141
```
4242
You can replace `all` with, for instance, `auspice/ncov_open_global.json` to avoid building all regions.
4343
The resulting dataset(s) can be visualised in the browser by running `auspice view --datasetDir auspice`.
@@ -49,13 +49,13 @@ You may wish to overwrite these parameters for your local runs to avoid overwrit
4949
For instance, here are the commands used by the trial builds action (see below):
5050
```sh
5151
nextstrain build . upload deploy \
52-
--profile nextstrain_profiles/nextstrain-open \
52+
--configfile nextstrain_configs/open/builds.yaml \
5353
--config \
5454
S3_DST_BUCKET=nextstrain-staging/files/ncov/open/trial/TRIAL_NAME \
5555
deploy_url=s3://nextstrain-staging/ \
5656
auspice_json_prefix=ncov_open_trial_TRIAL_NAME
5757
nextstrain build . upload deploy \
58-
--profile nextstrain_profiles/nextstrain-gisaid \
58+
--configfile nextstrain_configs/gisaid/builds.yaml \
5959
--config \
6060
S3_DST_BUCKET=nextstrain-ncov-private/trial/TRIAL_NAME \
6161
deploy_url=s3://nextstrain-staging/ \

docs/src/reference/files.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,4 @@ These files are used to generate the `workflow documentation <https://docs.nexts
7575
Nextstrain user files
7676
~~~~~~~~~~~~~~~~~~~~~
7777

78-
The Nextstrain team maintains user files in the ``ncov/`` repo, under ``nextstrain_profiles/``.
78+
The Nextstrain team maintains user files in the ``ncov/`` repo, under ``nextstrain_configs/``.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ It will upload these files:
99
* `s3://nextstrain-ncov-private/100k/metadata.tsv.xz`
1010
* `s3://nextstrain-ncov-private/100k/sequences.fasta.xz`
1111

12-
While this profile is not recommended to be run locally, you can see what rules would be run via:
12+
While this workflow configuration is not recommended to be run locally, you can see what rules would be run via:
1313

1414
```
15-
snakemake --cores 1 --configfile nextstrain_profiles/100k/config-gisaid.yaml -npf upload --dag | dot -Tpdf > dag-100k-gisaid.pdf
16-
snakemake --cores 1 --configfile nextstrain_profiles/100k/config-open.yaml -npf upload --dag | dot -Tpdf > dag-100k-open.pdf
15+
snakemake --cores 1 --configfile nextstrain_configs/100k/config-gisaid.yaml -npf upload --dag | dot -Tpdf > dag-100k-gisaid.pdf
16+
snakemake --cores 1 --configfile nextstrain_configs/100k/config-open.yaml -npf upload --dag | dot -Tpdf > dag-100k-open.pdf
1717
```
1818

1919
To run manually you can trigger the GitHub action (recommended) or run the jobs locally via:
2020
```
2121
nextstrain build --aws-batch --cpus 16 --memory 31GiB --detach . \
22-
--configfile nextstrain_profiles/100k/config-gisaid.yaml \
22+
--configfile nextstrain_configs/100k/config-gisaid.yaml \
2323
-f upload
2424
nextstrain build --aws-batch --cpus 16 --memory 31GiB --detach . \
25-
--configfile nextstrain_profiles/100k/config-open.yaml \
25+
--configfile nextstrain_configs/100k/config-open.yaml \
2626
-f upload
2727
```
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)