Skip to content

Commit 4b7c259

Browse files
jplfariaclaude
andcommitted
Make skeleton generic: remove hardcoded username and names
- Replace 'jplfaria' with '{your_username}' throughout - Replace 'Ask Gavin' with 'Ask a CTS admin' - Completed tools table shows only tools built via this skeleton (not checkm2/interproscan which predate it) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 32720b6 commit 4b7c259

2 files changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Copy this repo to create a new tool: `kbaseincubator/cdm_{toolname}`.
1111
1. **Copy this repo** → rename to `kbaseincubator/cdm_{toolname}`
1212
2. **Edit `Dockerfile`** → swap in the real tool image and entrypoint
1313
3. **Push / tag a release** → GitHub Actions builds and pushes to GHCR automatically
14-
4. **Ask Gavin to register the image** in CTS (you cannot do this yourself)
15-
5. **Create a demo notebook** at `global_share/jplfaria/{toolname}_demo.ipynb` on hub.berdl.kbase.us
14+
4. **Ask a CTS admin to register the image** (see `docs/pattern.md` — regular users cannot register images)
15+
5. **Create a demo notebook** at `global_share/{your_username}/{toolname}_demo.ipynb` on hub.berdl.kbase.us
1616
6. **Submit a job** and verify output lands in MinIO
1717
7. **Write an importer** (PR to `kbase/cdm-spark-events-importers`) to load results into Delta Lake
1818

@@ -37,11 +37,10 @@ Demo notebooks and importers live in separate repos (see `docs/pattern.md`).
3737

3838
---
3939

40-
## Completed Tools
40+
## Tools Implemented via This Skeleton
4141

4242
| Tool | Repo | Image | Mode | Refdata |
4343
|------|------|-------|------|---------|
44-
| checkm2 | [cdm_checkm2](https://github.com/kbasetest/cdm_checkm2) | `ghcr.io/kbasetest/cdm_checkm2:0.3.0` | genome quality | yes |
4544
| mmseqs2 | [cdm_mmseqs2](https://github.com/kbaseincubator/cdm_mmseqs2) | `ghcr.io/kbaseincubator/cdm_mmseqs2:0.1.0` | easy-cluster | no |
4645

4746
## Planned Tools

docs/pattern.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ Go to `https://github.com/orgs/kbaseincubator/packages/container/{toolname}/sett
8383

8484
## Step 3: Register the Image
8585

86-
You **cannot** register images yourself (requires `full_admin` role). Ask Gavin:
86+
Regular users **cannot** register images (requires `full_admin` role). Ask a CTS admin:
8787

88-
> Hey Gavin, can you register this image in CTS?
88+
> Hi, can you register this image in CTS?
8989
> `ghcr.io/kbaseincubator/cdm_{toolname}:{ver}@sha256:{manifest_list_digest}`
9090
> Entrypoint is `{entrypoint}`. {Refdata note: "No refdata needed" or "Needs refdata at /ref_data/..."}.
9191
> Usage note: {one sentence on how to use it}.
@@ -101,7 +101,7 @@ curl -s "https://berdl.kbase.us/apis/cts/images/ghcr.io%2Fkbaseincubator%2Fcdm_{
101101

102102
## Step 4: Demo Notebook on berdl.kbase.us
103103

104-
Create `global_share/jplfaria/{toolname}_demo.ipynb`.
104+
Create `global_share/{your_username}/{toolname}_demo.ipynb`.
105105

106106
### Standard notebook structure
107107

@@ -118,7 +118,7 @@ print(f"{len(input_files)} files:", *input_files, sep="\n")
118118

119119
# Cell 3: Submit job
120120
IMAGE = "ghcr.io/kbaseincubator/cdm_{toolname}:{ver}@sha256:{digest}"
121-
OUTPUT_DIR = "cts/io/jplfaria/output/{toolname}/test/v1"
121+
OUTPUT_DIR = "cts/io/{your_username}/output/{toolname}/test/v1"
122122

123123
job = tscli.submit_job(
124124
IMAGE,
@@ -161,7 +161,7 @@ for o in job.get_job()["outputs"]:
161161

162162
### Output path with `declobber=True`
163163

164-
Files land at: `cts/io/jplfaria/output/{toolname}/test/v1/{container_num}/{filename}`
164+
Files land at: `cts/io/{your_username}/output/{toolname}/test/v1/{container_num}/{filename}`
165165

166166
---
167167

@@ -269,8 +269,8 @@ importer_meta:
269269
| CTS API | `https://berdl.kbase.us/apis/cts/` |
270270
| MinIO bucket | `cts` — write path `cts/io/` |
271271
| Input test files | `cts/io/gavin/test_files/` (4 genomes with CRC64NVME checksums) |
272-
| José output path | `cts/io/jplfaria/output/{toolname}/` |
273-
| Delta Lake tables | `u_jplfaria__autoimport.{toolname}` (after importer deployed) |
272+
| José output path | `cts/io/{your_username}/output/{toolname}/` |
273+
| Delta Lake tables | `u_{your_username}__autoimport.{toolname}` (after importer deployed) |
274274

275275
---
276276

0 commit comments

Comments
 (0)