spatial-aim 1.1.0__tar.gz → 1.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/.gitignore +3 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/PKG-INFO +2 -1
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/environment.yml +1 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/pyproject.toml +4 -1
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatial_aim.egg-info/PKG-INFO +2 -1
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatial_aim.egg-info/SOURCES.txt +15 -13
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatial_aim.egg-info/requires.txt +1 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatial_aim.egg-info/scm_file_list.json +15 -13
- spatial_aim-1.2.0/src/spatial_aim.egg-info/scm_version.json +8 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/README.md +11 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/__init__.py +12 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/_common.py +192 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_01_mouse_ssp.py +339 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_02_colorectal_cancer.py +333 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_03_mouse_liver.py +284 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_04_mouse_kidney.py +307 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_05_mouse_embryo.py +482 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_06_mouse_retina.py +488 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_07_mouse_mpfc.py +277 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_08_mouse_visual_cortex.py +312 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_09_human_breast_cancer.py +259 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/curate_10_human_mtg.py +212 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/dump_retina_counts.R +55 -0
- spatial_aim-1.2.0/src/spatialaim/data/curate_datasets/environment_retina_qs.yml +17 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/gui/app.py +242 -10
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/gui/data_access.py +13 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/gui/render.py +696 -85
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/gui/state_names.py +9 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/gui/widgets.py +120 -46
- spatial_aim-1.1.0/src/spatial_aim.egg-info/scm_version.json +0 -8
- spatial_aim-1.1.0/src/spatialaim/data/prepare/build_imaging_pairs.py +0 -397
- spatial_aim-1.1.0/src/spatialaim/data/prepare/build_xenium_breast_pair.py +0 -311
- spatial_aim-1.1.0/src/spatialaim/data/prepare/convertTsvToCsv.py +0 -39
- spatial_aim-1.1.0/src/spatialaim/data/prepare/convert_csv_to_h5ad.py +0 -217
- spatial_aim-1.1.0/src/spatialaim/data/prepare/createOnlyHVGDataset.py +0 -69
- spatial_aim-1.1.0/src/spatialaim/data/prepare/createSmallerDataset.py +0 -102
- spatial_aim-1.1.0/src/spatialaim/data/prepare/normalize_gene_names.py +0 -56
- spatial_aim-1.1.0/src/spatialaim/data/prepare/perturb_sc_noise.py +0 -107
- spatial_aim-1.1.0/src/spatialaim/data/prepare/register_st_patches.py +0 -180
- spatial_aim-1.1.0/src/spatialaim/data/prepare/split_st_into_islands.py +0 -551
- spatial_aim-1.1.0/src/spatialaim/data/prepare/split_st_into_patches.py +0 -240
- spatial_aim-1.1.0/src/spatialaim/data/prepare/subset_st_hvg.py +0 -43
- spatial_aim-1.1.0/src/spatialaim/reference_aligners/__init__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/.github/workflows/ci.yml +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/.github/workflows/release.yml +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/.pre-commit-config.yaml +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/LICENSE +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/README.md +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/docs/aim_gui.gif +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/docs/figure_2_1.png +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/renovate.json +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/sample_dataset/ST/index.csv +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/sample_dataset/ST/sample_st.h5ad +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/sample_dataset/pairs.csv +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/sample_dataset/scRNA/index.csv +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/sample_dataset/scRNA/sample_sc.h5ad +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/setup.cfg +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatial_aim.egg-info/dependency_links.txt +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatial_aim.egg-info/entry_points.txt +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatial_aim.egg-info/top_level.txt +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/__init__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/__main__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/adata_schema.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/aggregation.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/__init__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/analysis.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/biology.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/confidence.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/ksweep.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/loading.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/onehot.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/reconstruction.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/topology.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/analysis/utils.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/cli.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/clustering.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/config.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/data/__init__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/data/validate/__init__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/data/validate/common.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/data/validate/runner.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/data/validate/validate_pair.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/data/validate/validate_sc.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/data/validate/validate_st.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/gui/__init__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/gui/__main__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/gui/compute.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/gui/scaffold.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/io.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/mapping/__init__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/mapping/base.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/mapping/confidence.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/mapping/nearest_centroid.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/mapping/reference.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/mapping/wann.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/metrics/__init__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/metrics/biology.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/metrics/cossim.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/metrics/kselection.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/metrics/onehot.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/metrics/reconstruction.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/metrics/topology.py +0 -0
- {spatial_aim-1.1.0/src/spatialaim/data/prepare → spatial_aim-1.2.0/src/spatialaim/reference_aligners}/__init__.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/reference_aligners/environment_dot.yml +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/reference_aligners/environment_tacco.yml +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/reference_aligners/environment_tangram.yml +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/reference_aligners/registry.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/reference_aligners/run_dot.R +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/reference_aligners/run_dot.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/reference_aligners/run_tacco.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/reference_aligners/run_tangram.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/sweep.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/src/spatialaim/tree.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/tests/test_cli.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/tests/test_gui_imports.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/tests/test_registry.py +0 -0
- {spatial_aim-1.1.0 → spatial_aim-1.2.0}/tests/test_sweep_sample.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: spatial-aim
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.2.0
|
|
4
4
|
Summary: SpatialAIM — annotation-independent mapping of scRNA-seq references onto high-resolution spatial transcriptomics
|
|
5
5
|
Author-email: Dominik Pysch <dominik.pysch@fau.de>
|
|
6
6
|
License: GNU GENERAL PUBLIC LICENSE
|
|
@@ -708,6 +708,7 @@ Requires-Dist: kaleido>=0.2
|
|
|
708
708
|
Provides-Extra: data
|
|
709
709
|
Requires-Dist: matplotlib>=3.9; extra == "data"
|
|
710
710
|
Requires-Dist: scikit-learn>=1.4; extra == "data"
|
|
711
|
+
Requires-Dist: rdata>=1.1; extra == "data"
|
|
711
712
|
Provides-Extra: dev
|
|
712
713
|
Requires-Dist: pytest>=8; extra == "dev"
|
|
713
714
|
Requires-Dist: black>=24; extra == "dev"
|
|
@@ -18,6 +18,7 @@ dependencies:
|
|
|
18
18
|
- scanpy==1.11.5 # Leiden over-clustering, UMAP, analysis.biology
|
|
19
19
|
# --- data preparation only ---
|
|
20
20
|
- matplotlib==3.9.2
|
|
21
|
+
- rdata # read R .Rds sources (curate_datasets/curate_05_mouse_embryo)
|
|
21
22
|
- pip:
|
|
22
23
|
# --- core (pip-only) ---
|
|
23
24
|
- igraph # modularity (metrics.biology)
|
|
@@ -51,7 +51,7 @@ dependencies = [
|
|
|
51
51
|
]
|
|
52
52
|
|
|
53
53
|
[project.optional-dependencies]
|
|
54
|
-
data = ["matplotlib>=3.9", "scikit-learn>=1.4"]
|
|
54
|
+
data = ["matplotlib>=3.9", "scikit-learn>=1.4", "rdata>=1.1"]
|
|
55
55
|
dev = [
|
|
56
56
|
"pytest>=8",
|
|
57
57
|
"black>=24",
|
|
@@ -75,6 +75,9 @@ where = ["src"]
|
|
|
75
75
|
# Ship the reference-aligner env specs and the DOT R script alongside the package
|
|
76
76
|
# so users can create the reference envs and the dot aligner can find its script.
|
|
77
77
|
"spatialaim.reference_aligners" = ["*.yml", "*.R"]
|
|
78
|
+
# curate_06_mouse_retina reads an R .qs object, so it ships an R script and the
|
|
79
|
+
# env spec for the small R environment that runs it.
|
|
80
|
+
"spatialaim.data.curate_datasets" = ["*.yml", "*.R"]
|
|
78
81
|
|
|
79
82
|
[tool.setuptools_scm]
|
|
80
83
|
# Version is derived from git tags (e.g. v0.1.0). Falls back to 0.0.0.dev* in a
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: spatial-aim
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.2.0
|
|
4
4
|
Summary: SpatialAIM — annotation-independent mapping of scRNA-seq references onto high-resolution spatial transcriptomics
|
|
5
5
|
Author-email: Dominik Pysch <dominik.pysch@fau.de>
|
|
6
6
|
License: GNU GENERAL PUBLIC LICENSE
|
|
@@ -708,6 +708,7 @@ Requires-Dist: kaleido>=0.2
|
|
|
708
708
|
Provides-Extra: data
|
|
709
709
|
Requires-Dist: matplotlib>=3.9; extra == "data"
|
|
710
710
|
Requires-Dist: scikit-learn>=1.4; extra == "data"
|
|
711
|
+
Requires-Dist: rdata>=1.1; extra == "data"
|
|
711
712
|
Provides-Extra: dev
|
|
712
713
|
Requires-Dist: pytest>=8; extra == "dev"
|
|
713
714
|
Requires-Dist: black>=24; extra == "dev"
|
|
@@ -43,19 +43,21 @@ src/spatialaim/analysis/reconstruction.py
|
|
|
43
43
|
src/spatialaim/analysis/topology.py
|
|
44
44
|
src/spatialaim/analysis/utils.py
|
|
45
45
|
src/spatialaim/data/__init__.py
|
|
46
|
-
src/spatialaim/data/
|
|
47
|
-
src/spatialaim/data/
|
|
48
|
-
src/spatialaim/data/
|
|
49
|
-
src/spatialaim/data/
|
|
50
|
-
src/spatialaim/data/
|
|
51
|
-
src/spatialaim/data/
|
|
52
|
-
src/spatialaim/data/
|
|
53
|
-
src/spatialaim/data/
|
|
54
|
-
src/spatialaim/data/
|
|
55
|
-
src/spatialaim/data/
|
|
56
|
-
src/spatialaim/data/
|
|
57
|
-
src/spatialaim/data/
|
|
58
|
-
src/spatialaim/data/
|
|
46
|
+
src/spatialaim/data/curate_datasets/README.md
|
|
47
|
+
src/spatialaim/data/curate_datasets/__init__.py
|
|
48
|
+
src/spatialaim/data/curate_datasets/_common.py
|
|
49
|
+
src/spatialaim/data/curate_datasets/curate_01_mouse_ssp.py
|
|
50
|
+
src/spatialaim/data/curate_datasets/curate_02_colorectal_cancer.py
|
|
51
|
+
src/spatialaim/data/curate_datasets/curate_03_mouse_liver.py
|
|
52
|
+
src/spatialaim/data/curate_datasets/curate_04_mouse_kidney.py
|
|
53
|
+
src/spatialaim/data/curate_datasets/curate_05_mouse_embryo.py
|
|
54
|
+
src/spatialaim/data/curate_datasets/curate_06_mouse_retina.py
|
|
55
|
+
src/spatialaim/data/curate_datasets/curate_07_mouse_mpfc.py
|
|
56
|
+
src/spatialaim/data/curate_datasets/curate_08_mouse_visual_cortex.py
|
|
57
|
+
src/spatialaim/data/curate_datasets/curate_09_human_breast_cancer.py
|
|
58
|
+
src/spatialaim/data/curate_datasets/curate_10_human_mtg.py
|
|
59
|
+
src/spatialaim/data/curate_datasets/dump_retina_counts.R
|
|
60
|
+
src/spatialaim/data/curate_datasets/environment_retina_qs.yml
|
|
59
61
|
src/spatialaim/data/validate/__init__.py
|
|
60
62
|
src/spatialaim/data/validate/common.py
|
|
61
63
|
src/spatialaim/data/validate/runner.py
|
|
@@ -34,19 +34,21 @@
|
|
|
34
34
|
"src/spatialaim/clustering.py",
|
|
35
35
|
"src/spatialaim/config.py",
|
|
36
36
|
"src/spatialaim/data/__init__.py",
|
|
37
|
-
"src/spatialaim/data/
|
|
38
|
-
"src/spatialaim/data/
|
|
39
|
-
"src/spatialaim/data/
|
|
40
|
-
"src/spatialaim/data/
|
|
41
|
-
"src/spatialaim/data/
|
|
42
|
-
"src/spatialaim/data/
|
|
43
|
-
"src/spatialaim/data/
|
|
44
|
-
"src/spatialaim/data/
|
|
45
|
-
"src/spatialaim/data/
|
|
46
|
-
"src/spatialaim/data/
|
|
47
|
-
"src/spatialaim/data/
|
|
48
|
-
"src/spatialaim/data/
|
|
49
|
-
"src/spatialaim/data/
|
|
37
|
+
"src/spatialaim/data/curate_datasets/README.md",
|
|
38
|
+
"src/spatialaim/data/curate_datasets/__init__.py",
|
|
39
|
+
"src/spatialaim/data/curate_datasets/_common.py",
|
|
40
|
+
"src/spatialaim/data/curate_datasets/curate_01_mouse_ssp.py",
|
|
41
|
+
"src/spatialaim/data/curate_datasets/curate_02_colorectal_cancer.py",
|
|
42
|
+
"src/spatialaim/data/curate_datasets/curate_03_mouse_liver.py",
|
|
43
|
+
"src/spatialaim/data/curate_datasets/curate_04_mouse_kidney.py",
|
|
44
|
+
"src/spatialaim/data/curate_datasets/curate_05_mouse_embryo.py",
|
|
45
|
+
"src/spatialaim/data/curate_datasets/curate_06_mouse_retina.py",
|
|
46
|
+
"src/spatialaim/data/curate_datasets/curate_07_mouse_mpfc.py",
|
|
47
|
+
"src/spatialaim/data/curate_datasets/curate_08_mouse_visual_cortex.py",
|
|
48
|
+
"src/spatialaim/data/curate_datasets/curate_09_human_breast_cancer.py",
|
|
49
|
+
"src/spatialaim/data/curate_datasets/curate_10_human_mtg.py",
|
|
50
|
+
"src/spatialaim/data/curate_datasets/dump_retina_counts.R",
|
|
51
|
+
"src/spatialaim/data/curate_datasets/environment_retina_qs.yml",
|
|
50
52
|
"src/spatialaim/data/validate/__init__.py",
|
|
51
53
|
"src/spatialaim/data/validate/common.py",
|
|
52
54
|
"src/spatialaim/data/validate/runner.py",
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Dataset curation
|
|
2
|
+
|
|
3
|
+
These 10 scripts will curate the datasets used in our experiments.
|
|
4
|
+
They will download the datasets and convert the data into the required format.
|
|
5
|
+
All but one work fully automatically: `curate_02_colorectal_cancer.py` takes its ST counts from the
|
|
6
|
+
raw Vizgen release, which needs a Google sign-in; the script prints what to download and asks for
|
|
7
|
+
the folder (or takes it from `--vizgen-dir`).
|
|
8
|
+
Only minor pre-processing (deleting near-empty columns etc.) has been applied.
|
|
9
|
+
No normalization or log operations are applied to the data, as we are working on raw counts.
|
|
10
|
+
|
|
11
|
+
These 10 script are fully generated by AI (Claude Opus 5.5).
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Reproducible curation of the SpatialAIM dataset collection.
|
|
3
|
+
|
|
4
|
+
One module per scRNA reference (``curate_<nn>_<name>.py``). Each downloads its
|
|
5
|
+
reference and every ST slice paired with it from the *original* public source
|
|
6
|
+
and rebuilds the h5ad files that ``Data/01_Datasets_Used`` ships, byte-for-byte
|
|
7
|
+
where the source allows it.
|
|
8
|
+
|
|
9
|
+
Each script takes a single argument, ``--out-dir``; it downloads its sources
|
|
10
|
+
into a temporary folder below it and deletes them again, so only the final
|
|
11
|
+
h5ad files remain. Shared download/write helpers live in ``_common.py``.
|
|
12
|
+
"""
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Shared helpers for the ``curate_datasets`` scripts.
|
|
3
|
+
|
|
4
|
+
Every curation script takes a single argument, ``--out-dir``, downloads its
|
|
5
|
+
sources into a temporary folder below it, builds the h5ad files and deletes the
|
|
6
|
+
downloads again — so only the final datasets survive a run.
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
import argparse
|
|
10
|
+
import contextlib
|
|
11
|
+
import logging
|
|
12
|
+
import os
|
|
13
|
+
import shutil
|
|
14
|
+
import sys
|
|
15
|
+
import tempfile
|
|
16
|
+
import urllib.error
|
|
17
|
+
import urllib.request
|
|
18
|
+
from collections.abc import Iterator
|
|
19
|
+
from pathlib import Path
|
|
20
|
+
from typing import Iterable
|
|
21
|
+
|
|
22
|
+
logger = logging.getLogger(__name__)
|
|
23
|
+
|
|
24
|
+
DATA_ROOT = Path(r"C:\Users\zi69hebi\Dev\10_Alignment\Data")
|
|
25
|
+
# The paper's dataset database: the curated 10 references and their ST slices.
|
|
26
|
+
# (Built as 02_Datasets_Reproducable; moved here once it replaced the old set.)
|
|
27
|
+
OUT_ROOT = DATA_ROOT / "01_Datasets_Paper"
|
|
28
|
+
|
|
29
|
+
_USER_AGENT = "spatialaim-curate/1.0 (academic dataset reproduction)"
|
|
30
|
+
_CHUNK = 1 << 20 # 1 MiB
|
|
31
|
+
_REPORT_EVERY = 256 << 20 # log progress every 256 MiB
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
# --------------------------------------------------------------------------- #
|
|
35
|
+
# CLI
|
|
36
|
+
# --------------------------------------------------------------------------- #
|
|
37
|
+
def build_parser(description: str) -> argparse.ArgumentParser:
|
|
38
|
+
parser = argparse.ArgumentParser(
|
|
39
|
+
description=description,
|
|
40
|
+
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
41
|
+
)
|
|
42
|
+
parser.add_argument(
|
|
43
|
+
"--out-dir",
|
|
44
|
+
type=Path,
|
|
45
|
+
default=OUT_ROOT,
|
|
46
|
+
help=f"Target root; scRNA/ and ST/ are created below it (default: {OUT_ROOT})",
|
|
47
|
+
)
|
|
48
|
+
return parser
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
def setup_logging() -> None:
|
|
52
|
+
logging.basicConfig(
|
|
53
|
+
stream=sys.stdout,
|
|
54
|
+
level=logging.INFO,
|
|
55
|
+
format="%(asctime)s | %(message)s",
|
|
56
|
+
datefmt="%H:%M:%S",
|
|
57
|
+
)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
def prepare_dirs(out_dir: Path) -> tuple[Path, Path]:
|
|
61
|
+
"""Create and return (sc_dir, st_dir) below ``out_dir``."""
|
|
62
|
+
sc_dir, st_dir = out_dir / "scRNA", out_dir / "ST"
|
|
63
|
+
for directory in (sc_dir, st_dir):
|
|
64
|
+
directory.mkdir(parents=True, exist_ok=True)
|
|
65
|
+
return sc_dir, st_dir
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
KEEP_ENV_VAR = "SPATIALAIM_KEEP_DOWNLOADS"
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
@contextlib.contextmanager
|
|
72
|
+
def staging(out_dir: Path, name: str) -> Iterator[Path]:
|
|
73
|
+
"""
|
|
74
|
+
Yield the folder the sources are downloaded into, and clean it up after.
|
|
75
|
+
|
|
76
|
+
Setting ``SPATIALAIM_KEEP_DOWNLOADS=1`` keeps them in
|
|
77
|
+
``<out_dir>/_downloads/<name>`` instead, where ``download`` finds and reuses
|
|
78
|
+
them — for debugging a curation script without refetching gigabytes.
|
|
79
|
+
"""
|
|
80
|
+
if os.environ.get(KEEP_ENV_VAR):
|
|
81
|
+
kept = out_dir / "_downloads" / name
|
|
82
|
+
kept.mkdir(parents=True, exist_ok=True)
|
|
83
|
+
logger.info("%s set — keeping downloads in %s", KEEP_ENV_VAR, kept)
|
|
84
|
+
yield kept
|
|
85
|
+
logger.info("downloads kept in %s (delete when done debugging)", kept)
|
|
86
|
+
else:
|
|
87
|
+
with tempfile.TemporaryDirectory(dir=out_dir, prefix=f"_tmp_{name}_") as tmp:
|
|
88
|
+
yield Path(tmp)
|
|
89
|
+
logger.info("intermediates removed")
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
# --------------------------------------------------------------------------- #
|
|
93
|
+
# Download
|
|
94
|
+
# --------------------------------------------------------------------------- #
|
|
95
|
+
def _remote_size(url: str) -> int | None:
|
|
96
|
+
request = urllib.request.Request(
|
|
97
|
+
url, method="HEAD", headers={"User-Agent": _USER_AGENT}
|
|
98
|
+
)
|
|
99
|
+
try:
|
|
100
|
+
with urllib.request.urlopen(request, timeout=60) as response:
|
|
101
|
+
length = response.headers.get("Content-Length")
|
|
102
|
+
return int(length) if length is not None else None
|
|
103
|
+
except (urllib.error.URLError, ValueError, TimeoutError):
|
|
104
|
+
return None
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
def download(url: str, dest: Path, *, expected_bytes: int | None = None) -> Path:
|
|
108
|
+
"""
|
|
109
|
+
Fetch ``url`` to ``dest``.
|
|
110
|
+
|
|
111
|
+
``expected_bytes`` is the size recorded when the source was verified and is
|
|
112
|
+
used as the size check whenever the server reports no Content-Length.
|
|
113
|
+
"""
|
|
114
|
+
dest.parent.mkdir(parents=True, exist_ok=True)
|
|
115
|
+
target = _remote_size(url)
|
|
116
|
+
if target is None:
|
|
117
|
+
target = expected_bytes
|
|
118
|
+
|
|
119
|
+
have = dest.stat().st_size if dest.exists() else 0
|
|
120
|
+
if have and target is not None:
|
|
121
|
+
if have == target:
|
|
122
|
+
logger.info(" cached %s (%s)", dest.name, _human(target))
|
|
123
|
+
return dest
|
|
124
|
+
if have > target: # not the same file any more
|
|
125
|
+
dest.unlink()
|
|
126
|
+
have = 0
|
|
127
|
+
|
|
128
|
+
headers = {"User-Agent": _USER_AGENT}
|
|
129
|
+
mode = "wb"
|
|
130
|
+
if have:
|
|
131
|
+
# only reachable in keep-downloads mode, where a partial file survives
|
|
132
|
+
headers["Range"] = f"bytes={have}-"
|
|
133
|
+
mode = "ab"
|
|
134
|
+
logger.info(" resume %s at %s / %s", dest.name, _human(have), _human(target))
|
|
135
|
+
else:
|
|
136
|
+
logger.info(" get %s (%s)", dest.name, _human(target))
|
|
137
|
+
|
|
138
|
+
request = urllib.request.Request(url, headers=headers)
|
|
139
|
+
with urllib.request.urlopen(request, timeout=120) as response:
|
|
140
|
+
if have and response.status != 206: # server ignored the Range header
|
|
141
|
+
mode, have = "wb", 0
|
|
142
|
+
with open(dest, mode) as handle:
|
|
143
|
+
done = have
|
|
144
|
+
next_report = done + _REPORT_EVERY
|
|
145
|
+
while True:
|
|
146
|
+
chunk = response.read(_CHUNK)
|
|
147
|
+
if not chunk:
|
|
148
|
+
break
|
|
149
|
+
handle.write(chunk)
|
|
150
|
+
done += len(chunk)
|
|
151
|
+
if done >= next_report:
|
|
152
|
+
logger.info(" %s / %s", _human(done), _human(target))
|
|
153
|
+
next_report += _REPORT_EVERY
|
|
154
|
+
|
|
155
|
+
size = dest.stat().st_size
|
|
156
|
+
if target is not None and size != target:
|
|
157
|
+
raise IOError(f"{dest.name}: got {size} bytes, expected {target}")
|
|
158
|
+
logger.info(" done %s (%s)", dest.name, _human(size))
|
|
159
|
+
return dest
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
def _human(n: int | None) -> str:
|
|
163
|
+
if n is None:
|
|
164
|
+
return "unknown size"
|
|
165
|
+
value = float(n)
|
|
166
|
+
for unit in ("B", "KB", "MB", "GB"):
|
|
167
|
+
if value < 1024.0 or unit == "GB":
|
|
168
|
+
return f"{int(value)} B" if unit == "B" else f"{value:.1f} {unit}"
|
|
169
|
+
value /= 1024.0
|
|
170
|
+
return f"{value:.1f} GB"
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
# --------------------------------------------------------------------------- #
|
|
174
|
+
# Writing
|
|
175
|
+
# --------------------------------------------------------------------------- #
|
|
176
|
+
def uppercase(genes: Iterable[str]) -> list[str]:
|
|
177
|
+
"""The project-wide gene-name convention (see prepare/normalize_gene_names.py)."""
|
|
178
|
+
return [str(g).upper() for g in genes]
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
def write(adata, path: Path) -> None:
|
|
182
|
+
"""Write via a .part file so an interrupted run leaves no half dataset."""
|
|
183
|
+
tmp = path.with_suffix(".h5ad.part")
|
|
184
|
+
adata.write_h5ad(tmp)
|
|
185
|
+
shutil.move(str(tmp), str(path))
|
|
186
|
+
logger.info(
|
|
187
|
+
" wrote %s (%d x %d, %s)",
|
|
188
|
+
path.name,
|
|
189
|
+
adata.n_obs,
|
|
190
|
+
adata.n_vars,
|
|
191
|
+
_human(path.stat().st_size),
|
|
192
|
+
)
|