Skip to content

Commit bd5ef08

Browse files
fedorovclaude
andcommitted
docs: update README with GCS artifact URLs and current/ folder
Add table of supplementary parquet files (GDC mapping, TCIA subset), document the GCS bucket structure including the current/ folder that always points to the latest release, and list direct HTTPS URLs for individual artifacts. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 547ec88 commit bd5ef08

1 file changed

Lines changed: 40 additions & 6 deletions

File tree

README.md

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,50 @@ dictionary:
4040
| `ann_group_index` | - | Annotation group index |
4141
| `contrast_index` | - | Contrast agent index |
4242

43-
Additionally, a `gdc_idc_mapping.parquet` file mapping IDC patients to the
44-
[Genomic Data Commons (GDC)](https://gdc.cancer.gov) is generated and published
45-
alongside the index files (not included in the PyPI package).
43+
Additionally, the following supplementary parquet files are generated and
44+
published alongside the index files (not included in the PyPI package):
45+
46+
| File | Description |
47+
| ------------------------- | -------------------------------------------------------------------------------------- |
48+
| `gdc_idc_mapping.parquet` | Mapping of IDC patients to [GDC](https://gdc.cancer.gov) cases |
49+
| `tcia_idc_subset.parquet` | Subset of IDC index columns for [TCIA](https://www.cancerimagingarchive.net) workflows |
4650

4751
All index files (including supplementary ones) are available from:
4852

4953
- **GitHub Releases**: attached as release assets
50-
- **Google Cloud Storage**: `gs://idc-index-data-artifacts/<version>/` (publicly
51-
readable, e.g.
52-
`https://storage.googleapis.com/idc-index-data-artifacts/23.5.0/idc_index.parquet`)
54+
- **Google Cloud Storage**: publicly readable via HTTPS
55+
56+
### Google Cloud Storage artifacts
57+
58+
Artifacts are uploaded to the `idc-index-data-artifacts` bucket on each release.
59+
Two paths are maintained:
60+
61+
| Path | Description |
62+
| ------------------------------------------ | ------------------------------------------------ |
63+
| `gs://idc-index-data-artifacts/<version>/` | Artifacts for a specific release (e.g. `23.5.0`) |
64+
| `gs://idc-index-data-artifacts/current/` | Always points to the latest release |
65+
66+
Individual files can be accessed via HTTPS at:
67+
68+
```
69+
https://storage.googleapis.com/idc-index-data-artifacts/current/<filename>
70+
```
71+
72+
For example:
73+
74+
| File | URL |
75+
| ------------------------- | --------------------------------------------------------------------------------------- |
76+
| `idc_index.parquet` | https://storage.googleapis.com/idc-index-data-artifacts/current/idc_index.parquet |
77+
| `idc_index_schema.json` | https://storage.googleapis.com/idc-index-data-artifacts/current/idc_index_schema.json |
78+
| `idc_index.sql` | https://storage.googleapis.com/idc-index-data-artifacts/current/idc_index.sql |
79+
| `clinical_index.parquet` | https://storage.googleapis.com/idc-index-data-artifacts/current/clinical_index.parquet |
80+
| `sm_index.parquet` | https://storage.googleapis.com/idc-index-data-artifacts/current/sm_index.parquet |
81+
| `seg_index.parquet` | https://storage.googleapis.com/idc-index-data-artifacts/current/seg_index.parquet |
82+
| `gdc_idc_mapping.parquet` | https://storage.googleapis.com/idc-index-data-artifacts/current/gdc_idc_mapping.parquet |
83+
| `tcia_idc_subset.parquet` | https://storage.googleapis.com/idc-index-data-artifacts/current/tcia_idc_subset.parquet |
84+
85+
Replace `current` with a specific version tag (e.g. `23.5.0`) to pin to a
86+
particular release.
5387

5488
## Usage
5589

0 commit comments

Comments
 (0)