immunopipe 2.4.4__tar.gz → 2.5.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.
Files changed (228) hide show
  1. immunopipe-2.5.0/.coveragerc +10 -0
  2. immunopipe-2.5.0/.dockerignore +147 -0
  3. immunopipe-2.5.0/.github/copilot-instructions.md +115 -0
  4. immunopipe-2.5.0/.github/workflows/build.yml +101 -0
  5. immunopipe-2.5.0/.github/workflows/deploy.yml +25 -0
  6. immunopipe-2.5.0/.github/workflows/docs-dev.yml +30 -0
  7. immunopipe-2.5.0/.github/workflows/docs.yml +31 -0
  8. immunopipe-2.5.0/.github/workflows/test.yml +188 -0
  9. immunopipe-2.5.0/.gitignore +135 -0
  10. immunopipe-2.5.0/AGENTS.md +175 -0
  11. immunopipe-2.5.0/Dockerfile +35 -0
  12. immunopipe-2.5.0/Dockerfile.base +23 -0
  13. immunopipe-2.5.0/Dockerfile.rpkgs +23 -0
  14. immunopipe-2.5.0/Makefile +113 -0
  15. {immunopipe-2.4.4 → immunopipe-2.5.0}/PKG-INFO +10 -20
  16. immunopipe-2.5.0/board.toml +101 -0
  17. immunopipe-2.5.0/docker/cleanup.list +354 -0
  18. immunopipe-2.5.0/docker/cleanup.py +72 -0
  19. immunopipe-2.5.0/docker/dockerhub-base-description.md +97 -0
  20. immunopipe-2.5.0/docker/dockerhub-description.md +201 -0
  21. immunopipe-2.5.0/docker/dockerhub-rpkgs-description.md +108 -0
  22. immunopipe-2.5.0/docker/entry.sh +61 -0
  23. immunopipe-2.5.0/docker/environment_base.yml +135 -0
  24. immunopipe-2.5.0/docker/environment_rpkgs.yml +15 -0
  25. immunopipe-2.5.0/docs/CHANGELOG.md +1130 -0
  26. immunopipe-2.5.0/docs/ImmunopipeMinimal.svg +126 -0
  27. immunopipe-2.5.0/docs/agent-skills.md +272 -0
  28. immunopipe-2.5.0/docs/assets/script.js +43 -0
  29. immunopipe-2.5.0/docs/assets/style.css +31 -0
  30. immunopipe-2.5.0/docs/configurations.md +537 -0
  31. immunopipe-2.5.0/docs/diagram.svg +380 -0
  32. immunopipe-2.5.0/docs/faq.md +286 -0
  33. immunopipe-2.5.0/docs/gallery.md +58 -0
  34. immunopipe-2.5.0/docs/getting-started.md +139 -0
  35. immunopipe-2.5.0/docs/img/favicon.ico +0 -0
  36. immunopipe-2.5.0/docs/immunopipe-caching.png +0 -0
  37. immunopipe-2.5.0/docs/immunopipe.flowchart.pdf +0 -0
  38. immunopipe-2.5.0/docs/immunopipe.flowchart.png +0 -0
  39. immunopipe-2.5.0/docs/immunopipe.gbatch.png +0 -0
  40. immunopipe-2.5.0/docs/immunopipe.ms.png +0 -0
  41. immunopipe-2.5.0/docs/installation.md +114 -0
  42. immunopipe-2.5.0/docs/introduction.md +125 -0
  43. immunopipe-2.5.0/docs/logo.png +0 -0
  44. immunopipe-2.5.0/docs/mcp-server.md +342 -0
  45. immunopipe-2.5.0/docs/pipen-board.gif +0 -0
  46. immunopipe-2.5.0/docs/pipen-cache.png +0 -0
  47. immunopipe-2.5.0/docs/preparing-input.md +133 -0
  48. immunopipe-2.5.0/docs/processes/CDR3AAPhyschem.md +56 -0
  49. immunopipe-2.5.0/docs/processes/CDR3Clustering.md +111 -0
  50. immunopipe-2.5.0/docs/processes/CellCellCommunication.md +162 -0
  51. immunopipe-2.5.0/docs/processes/CellCellCommunicationPlots.md +85 -0
  52. immunopipe-2.5.0/docs/processes/CellTypeAnnotation.md +200 -0
  53. immunopipe-2.5.0/docs/processes/ClonalStats.md +317 -0
  54. immunopipe-2.5.0/docs/processes/ClusterMarkers.md +346 -0
  55. immunopipe-2.5.0/docs/processes/ClusterMarkersOfAllCells.md +224 -0
  56. immunopipe-2.5.0/docs/processes/LoadingRNAFromSeurat.md +35 -0
  57. immunopipe-2.5.0/docs/processes/MarkersFinder.md +345 -0
  58. immunopipe-2.5.0/docs/processes/MetabolicExprImputation.md +60 -0
  59. immunopipe-2.5.0/docs/processes/MetabolicFeatures.md +114 -0
  60. immunopipe-2.5.0/docs/processes/MetabolicInput.md +16 -0
  61. immunopipe-2.5.0/docs/processes/MetabolicPathwayActivity.md +75 -0
  62. immunopipe-2.5.0/docs/processes/MetabolicPathwayHeterogeneity.md +69 -0
  63. immunopipe-2.5.0/docs/processes/ModuleScoreCalculator.md +123 -0
  64. immunopipe-2.5.0/docs/processes/PseudoBulkDEG.md +257 -0
  65. immunopipe-2.5.0/docs/processes/SampleInfo.md +270 -0
  66. immunopipe-2.5.0/docs/processes/ScFGSEA.md +166 -0
  67. immunopipe-2.5.0/docs/processes/ScRepCombiningExpression.md +57 -0
  68. immunopipe-2.5.0/docs/processes/ScRepLoading.md +98 -0
  69. immunopipe-2.5.0/docs/processes/ScrnaMetabolicLandscape.md +57 -0
  70. immunopipe-2.5.0/docs/processes/SeuratClusterStats.md +440 -0
  71. immunopipe-2.5.0/docs/processes/SeuratClustering.md +100 -0
  72. immunopipe-2.5.0/docs/processes/SeuratClusteringOfAllCells.md +92 -0
  73. immunopipe-2.5.0/docs/processes/SeuratMap2Ref.md +404 -0
  74. immunopipe-2.5.0/docs/processes/SeuratPreparing.md +308 -0
  75. immunopipe-2.5.0/docs/processes/SeuratSubClustering.md +106 -0
  76. immunopipe-2.5.0/docs/processes/TESSA.md +77 -0
  77. immunopipe-2.5.0/docs/processes/TOrBCellSelection.md +122 -0
  78. immunopipe-2.5.0/docs/processes/TopExpressingGenes.md +99 -0
  79. immunopipe-2.5.0/docs/processes/TopExpressingGenesOfAllCells.md +80 -0
  80. immunopipe-2.5.0/docs/processes/images/CellTypeAnnotation-metadata.png +0 -0
  81. immunopipe-2.5.0/docs/processes/images/CellsDistribution_example.png +0 -0
  82. immunopipe-2.5.0/docs/processes/images/CloneResidency.png +0 -0
  83. immunopipe-2.5.0/docs/processes/images/CloneResidency_venn.png +0 -0
  84. immunopipe-2.5.0/docs/processes/images/Immunarch-counts.png +0 -0
  85. immunopipe-2.5.0/docs/processes/images/Immunarch-hom_clones.png +0 -0
  86. immunopipe-2.5.0/docs/processes/images/Immunarch-top_clones_marks.png +0 -0
  87. immunopipe-2.5.0/docs/processes/images/Immunarch-volume-default.png +0 -0
  88. immunopipe-2.5.0/docs/processes/images/Immunarch_sample_diversity.png +0 -0
  89. immunopipe-2.5.0/docs/processes/images/MetabolicPathwayActivity_heatmap.png +0 -0
  90. immunopipe-2.5.0/docs/processes/images/MetabolicPathwayActivity_merged_heatmap.png +0 -0
  91. immunopipe-2.5.0/docs/processes/images/MetabolicPathwayActivity_violin.png +0 -0
  92. immunopipe-2.5.0/docs/processes/images/MetabolicPathwayHeterogeneity.png +0 -0
  93. immunopipe-2.5.0/docs/processes/images/ModuleScoreCalculator-metadata.png +0 -0
  94. immunopipe-2.5.0/docs/processes/images/RadarPlots-cluster_order.png +0 -0
  95. immunopipe-2.5.0/docs/processes/images/RadarPlots-default.png +0 -0
  96. immunopipe-2.5.0/docs/processes/images/RadarPlots-each.png +0 -0
  97. immunopipe-2.5.0/docs/processes/images/SampleInfo-infile.png +0 -0
  98. immunopipe-2.5.0/docs/processes/images/SampleInfo-report.png +0 -0
  99. immunopipe-2.5.0/docs/processes/images/SampleInfo_Samples_Source.png +0 -0
  100. immunopipe-2.5.0/docs/processes/images/SampleInfo_Score_Source.png +0 -0
  101. immunopipe-2.5.0/docs/processes/images/SeuratClusterStats_dimplots.png +0 -0
  102. immunopipe-2.5.0/docs/processes/images/SeuratClusterStats_fracCells_Sample.png +0 -0
  103. immunopipe-2.5.0/docs/processes/images/SeuratClusterStats_nCells_All.png +0 -0
  104. immunopipe-2.5.0/docs/processes/images/SeuratClusterStats_nCells_Sample.png +0 -0
  105. immunopipe-2.5.0/docs/processes/images/SeuratClusterStats_vlnplots.png +0 -0
  106. immunopipe-2.5.0/docs/processes/images/SeuratClusterStats_vlnplots_1.png +0 -0
  107. immunopipe-2.5.0/docs/processes/images/SeuratClustering-metadata.png +0 -0
  108. immunopipe-2.5.0/docs/processes/images/SeuratPreparing-metadata.png +0 -0
  109. immunopipe-2.5.0/docs/processes/images/SeuratSubClustering-metadata.png +0 -0
  110. immunopipe-2.5.0/docs/processes/images/TCRClusteringStats_cluster_size.png +0 -0
  111. immunopipe-2.5.0/docs/processes/images/TCRClusteringStats_sample_diversity.png +0 -0
  112. immunopipe-2.5.0/docs/processes/images/TCRClusteringStats_shared_clusters.png +0 -0
  113. immunopipe-2.5.0/docs/processes/images/TESSA-metadata.png +0 -0
  114. immunopipe-2.5.0/docs/processes/images/TOrBCellSelection-kmeans.png +0 -0
  115. immunopipe-2.5.0/docs/requirements.txt +10 -0
  116. immunopipe-2.5.0/docs/routes-notcr.png +0 -0
  117. immunopipe-2.5.0/docs/routes-tcr.png +0 -0
  118. immunopipe-2.5.0/docs/rtd-logo.png +0 -0
  119. immunopipe-2.5.0/docs/running.md +383 -0
  120. immunopipe-2.5.0/docs/singularity-pipen-board.png +0 -0
  121. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/cli_help.py +3 -1
  122. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/gbatch.py +4 -1
  123. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/processes.py +31 -27
  124. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/validate_config.py +31 -8
  125. immunopipe-2.5.0/immunopipe/version.py +18 -0
  126. immunopipe-2.5.0/immunopipe.config.example.toml +1655 -0
  127. immunopipe-2.5.0/mkdocs.yml +75 -0
  128. immunopipe-2.5.0/pyproject.toml +67 -0
  129. immunopipe-2.5.0/setup.py +9 -0
  130. immunopipe-2.5.0/skills/README.md +270 -0
  131. immunopipe-2.5.0/skills/cdr3aaphyschem/SKILL.md +313 -0
  132. immunopipe-2.5.0/skills/cdr3clustering/SKILL.md +243 -0
  133. immunopipe-2.5.0/skills/cellcellcommunication/SKILL.md +240 -0
  134. immunopipe-2.5.0/skills/cellcellcommunicationplots/SKILL.md +466 -0
  135. immunopipe-2.5.0/skills/celltypeannotation/SKILL.md +725 -0
  136. immunopipe-2.5.0/skills/clonalstats/SKILL.md +226 -0
  137. immunopipe-2.5.0/skills/clustermarkers/SKILL.md +493 -0
  138. immunopipe-2.5.0/skills/clustermarkersofallcells/SKILL.md +316 -0
  139. immunopipe-2.5.0/skills/immunopipe-config/SKILL.md +353 -0
  140. immunopipe-2.5.0/skills/loadingrnafromseurat/SKILL.md +349 -0
  141. immunopipe-2.5.0/skills/markersfinder/SKILL.md +257 -0
  142. immunopipe-2.5.0/skills/metabolicexpimputation/SKILL.md +623 -0
  143. immunopipe-2.5.0/skills/metabolicfeatures/SKILL.md +523 -0
  144. immunopipe-2.5.0/skills/metabolicinput/SKILL.md +334 -0
  145. immunopipe-2.5.0/skills/metabolicpathwayactivity/SKILL.md +428 -0
  146. immunopipe-2.5.0/skills/metabolicpathwayheterogeneity/SKILL.md +590 -0
  147. immunopipe-2.5.0/skills/modulescorecalculator/SKILL.md +470 -0
  148. immunopipe-2.5.0/skills/pseudobulkdeg/SKILL.md +677 -0
  149. immunopipe-2.5.0/skills/sampleinfo/SKILL.md +204 -0
  150. immunopipe-2.5.0/skills/scfgsea/SKILL.md +304 -0
  151. immunopipe-2.5.0/skills/screpcombiningexpression/SKILL.md +387 -0
  152. immunopipe-2.5.0/skills/screploading/SKILL.md +502 -0
  153. immunopipe-2.5.0/skills/scrnametaboliclandscape/SKILL.md +251 -0
  154. immunopipe-2.5.0/skills/seuratclustering/SKILL.md +525 -0
  155. immunopipe-2.5.0/skills/seuratclusteringofallcells/SKILL.md +198 -0
  156. immunopipe-2.5.0/skills/seuratclusterstats/SKILL.md +467 -0
  157. immunopipe-2.5.0/skills/seuratmap2ref/SKILL.md +241 -0
  158. immunopipe-2.5.0/skills/seuratpreparing/SKILL.md +637 -0
  159. immunopipe-2.5.0/skills/seuratsubclustering/SKILL.md +516 -0
  160. immunopipe-2.5.0/skills/tessa/SKILL.md +348 -0
  161. immunopipe-2.5.0/skills/topexpressinggenes/SKILL.md +195 -0
  162. immunopipe-2.5.0/skills/topexpressinggenesofallcells/SKILL.md +353 -0
  163. immunopipe-2.5.0/skills/torbcellselection/SKILL.md +470 -0
  164. immunopipe-2.5.0/tests/__init__.py +0 -0
  165. immunopipe-2.5.0/tests/conftest.py +159 -0
  166. immunopipe-2.5.0/tests/running/configs/CellCellCommunication.config.toml +25 -0
  167. immunopipe-2.5.0/tests/running/configs/ClonalStats.config.toml +114 -0
  168. immunopipe-2.5.0/tests/running/configs/ClusterMarkers.config.toml +61 -0
  169. immunopipe-2.5.0/tests/running/configs/SampleInfo.config.toml +31 -0
  170. immunopipe-2.5.0/tests/running/configs/ScFGSEA.config.toml +17 -0
  171. immunopipe-2.5.0/tests/running/configs/ScRep.config.toml +6 -0
  172. immunopipe-2.5.0/tests/running/configs/SeuratClusterStats.config.toml +121 -0
  173. immunopipe-2.5.0/tests/running/configs/SeuratClustering.config.toml +5 -0
  174. immunopipe-2.5.0/tests/running/configs/SeuratPreparing.config.toml +9 -0
  175. immunopipe-2.5.0/tests/running/configs/SeuratPreparing_sct.config.toml +9 -0
  176. immunopipe-2.5.0/tests/running/configs/TOrBCellSelection.config.toml +5 -0
  177. immunopipe-2.5.0/tests/running/configs/celltypeannotation_seuratmap2ref.config.toml +3 -0
  178. immunopipe-2.5.0/tests/running/configs/loadingrnafromseurat.config.toml +1 -0
  179. immunopipe-2.5.0/tests/running/configs/malformed.config.toml +1 -0
  180. immunopipe-2.5.0/tests/running/configs/mixed.config.toml +11 -0
  181. immunopipe-2.5.0/tests/running/configs/sampleinfo_multiple_infiles.config.toml +6 -0
  182. immunopipe-2.5.0/tests/running/configs/torbcellselection_seuratclusteringofallcells.config.toml +3 -0
  183. immunopipe-2.5.0/tests/running/data/sampleinfo.txt +13 -0
  184. immunopipe-2.5.0/tests/test_doc_extractor.py +241 -0
  185. immunopipe-2.5.0/tests/test_mcp_options.py +234 -0
  186. immunopipe-2.5.0/tests/test_mcp_toml_generator.py +290 -0
  187. immunopipe-2.5.0/tests/test_mcp_tools.py +318 -0
  188. immunopipe-2.5.0/tests/test_processes.py +149 -0
  189. immunopipe-2.5.0/tests/test_routes.py +476 -0
  190. immunopipe-2.5.0/tests/test_validate_config.py +114 -0
  191. immunopipe-2.5.0/tox.ini +7 -0
  192. immunopipe-2.5.0/uv.lock +4064 -0
  193. immunopipe-2.4.4/immunopipe/version.py +0 -6
  194. immunopipe-2.4.4/pyproject.toml +0 -61
  195. immunopipe-2.4.4/setup.py +0 -41
  196. {immunopipe-2.4.4 → immunopipe-2.5.0}/LICENSE +0 -0
  197. {immunopipe-2.4.4 → immunopipe-2.5.0}/README.md +0 -0
  198. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/__init__.py +0 -0
  199. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/__main__.py +0 -0
  200. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/cli_utils/AGENTS.md +0 -0
  201. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/cli_utils/__init__.py +0 -0
  202. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/cli_utils/check_dim.R +0 -0
  203. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/cli_utils/check_dim.py +0 -0
  204. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/cli_utils/check_genes.R +0 -0
  205. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/cli_utils/check_genes.py +0 -0
  206. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/cli_utils/utils.py +0 -0
  207. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/inhouse.py +0 -0
  208. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/AGENTS.md +0 -0
  209. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/README.md +0 -0
  210. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/__init__.py +0 -0
  211. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/doc_extractor.py +0 -0
  212. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/example.py +0 -0
  213. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/mcp_server.py +0 -0
  214. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/options.py +0 -0
  215. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/server.py +0 -0
  216. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/toml_generator.py +0 -0
  217. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/mcp/tools.py +0 -0
  218. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/pipeline.py +0 -0
  219. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/reports/CloneHeterogeneity.svelte +0 -0
  220. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/reports/MarkersOverlapping.svelte +0 -0
  221. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/reports/TCellSelection.svelte +0 -0
  222. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/reports/TOrBCellSelection.svelte +0 -0
  223. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/router.py +0 -0
  224. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/scripts/CloneHeterogeneity.R +0 -0
  225. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/scripts/LoadingRNAFromSeurat.R +0 -0
  226. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/scripts/MarkersOverlapping.R +0 -0
  227. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/scripts/TCellSelection.R +0 -0
  228. {immunopipe-2.4.4 → immunopipe-2.5.0}/immunopipe/scripts/TOrBCellSelection.R +0 -0
@@ -0,0 +1,10 @@
1
+ [run]
2
+ patch = subprocess
3
+ omit =
4
+ tests/*
5
+ setup.py
6
+
7
+ [report]
8
+ exclude_lines =
9
+ if TYPE_CHECKING:
10
+ pragma: no cover
@@ -0,0 +1,147 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ target/
76
+
77
+ # Jupyter Notebook
78
+ .ipynb_checkpoints
79
+
80
+ # IPython
81
+ profile_default/
82
+ ipython_config.py
83
+
84
+ # pyenv
85
+ .python-version
86
+
87
+ # pipenv
88
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
90
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
91
+ # install all needed dependencies.
92
+ #Pipfile.lock
93
+
94
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95
+ __pypackages__/
96
+
97
+ # Celery stuff
98
+ celerybeat-schedule
99
+ celerybeat.pid
100
+
101
+ # SageMath parsed files
102
+ *.sage.py
103
+
104
+ # Environments
105
+ .env
106
+ .venv
107
+ env/
108
+ venv/
109
+ ENV/
110
+ env.bak/
111
+ venv.bak/
112
+
113
+ # Spyder project settings
114
+ .spyderproject
115
+ .spyproject
116
+
117
+ # Rope project settings
118
+ .ropeproject
119
+
120
+ # mkdocs documentation
121
+ /site
122
+
123
+ # mypy
124
+ .mypy_cache/
125
+ .dmypy.json
126
+ dmypy.json
127
+
128
+ # Pyre type checker
129
+ .pyre/
130
+
131
+ # pytype static type analyzer
132
+ .pytype/
133
+
134
+ # Cython debug symbols
135
+ cython_debug/
136
+
137
+ # Editors
138
+ .vscode/
139
+ .idea/
140
+
141
+ # Project specific
142
+ .DS_Store
143
+ data/
144
+ output/
145
+ workdir/
146
+ .pipen/
147
+ *.bundle
@@ -0,0 +1,115 @@
1
+ # Immunopipe AI Coding Agent Instructions
2
+
3
+ ## Project Overview
4
+ Immunopipe is a comprehensive single-cell RNA-seq and TCR-seq analysis pipeline built on the **pipen** workflow framework. It orchestrates complex bioinformatics workflows for immune repertoire analysis, cell type annotation, metabolic profiling, and cell-cell communication.
5
+
6
+ ## Architecture
7
+
8
+ ### Core Components
9
+ - **`immunopipe/pipeline.py`**: Main pipeline orchestrator defining the workflow DAG
10
+ - **`immunopipe/processes.py`**: Individual process definitions (each process = one analysis step)
11
+ - **`immunopipe/router.py`**: Workflow routing logic based on input data types (TCR/non-TCR routes)
12
+ - **`immunopipe/gbatch.py`**: Batch processing utilities for multiple samples
13
+ - **`immunopipe/inhouse.py`**: Institution-specific customizations
14
+ - **`immunopipe/scripts/`**: R/Python analysis scripts executed by processes
15
+ - **`immunopipe/reports/`**: Report generation templates (likely Rmarkdown/HTML)
16
+ - **`immunopipe/mcp/`**: Model Context Protocol server for AI agent integration
17
+
18
+ ### Workflow Framework (pipen)
19
+ - Each "process" is a step in the pipeline with inputs, outputs, and a script
20
+ - Processes are connected via dependencies forming a DAG
21
+ - Configuration via `board.toml` (pipen-board UI config) and TOML config files
22
+ - Pipeline execution creates output directories with intermediate results
23
+
24
+ ### Key Data Flow
25
+ 1. Input: Sample metadata + scRNA-seq data (Seurat objects, counts matrices)
26
+ 2. Preprocessing: `SeuratPreparing` → QC and normalization
27
+ 3. Branching based on TCR presence (see `router.py`):
28
+ - **TCR route**: TCR clustering → T-cell selection → specialized analyses
29
+ - **No-TCR route**: Standard scRNA-seq analysis
30
+ 4. Core analyses: Clustering → marker identification → annotation → downstream (GSEA, metabolism, communication)
31
+ 5. Outputs: Processed Seurat objects, plots, HTML reports, tables
32
+
33
+ ## Development Workflows
34
+
35
+ ### Setup and Testing
36
+ ```bash
37
+ # Install with Poetry (preferred)
38
+ poetry install
39
+
40
+ # Run tests
41
+ poetry run pytest tests/
42
+
43
+ # Build Docker image
44
+ make docker # or docker build -t immunopipe .
45
+
46
+ # Run with Docker
47
+ docker run -v /data:/data immunopipe [args]
48
+ ```
49
+
50
+ ### Adding a New Process
51
+ 1. Define process class in `immunopipe/processes.py` (inherit from `Proc` or similar base)
52
+ 2. Add corresponding script in `immunopipe/scripts/` (R or Python)
53
+ 3. Update `immunopipe/pipeline.py` to wire the process into the DAG
54
+ 4. Add documentation in `docs/processes/ProcessName.md`
55
+ 5. Update routing logic in `immunopipe/router.py` if the process is route-specific
56
+
57
+ ### Configuration Validation
58
+ - `immunopipe/validate_config.py` validates user configurations
59
+ - Process-specific configs are defined in process classes (check `envs` attributes)
60
+ - See `docs/configurations.md` for user-facing config documentation
61
+
62
+ ## Project-Specific Conventions
63
+
64
+ ### File Organization
65
+ - **Process scripts naming**: `immunopipe/scripts/{ProcessName}.R` or `.py` (matches process class name)
66
+ - **Process docs**: `docs/processes/{ProcessName}.md` (one doc per process)
67
+ - **Tests**: `tests/test_{module}.py` (pytest-based)
68
+
69
+ ### Coding Patterns
70
+ - **Process definitions**: Use pipen's process class system with `input`, `output`, `script` attributes
71
+ - **R scripts**: Typically use Seurat ecosystem (Seurat, SeuratPlus, immunarch for TCR)
72
+ - **Python scripts**: Use scanpy/anndata for scRNA-seq, pandas for data manipulation
73
+ - **Config access**: Processes access config via `envs` dictionary passed from pipeline
74
+
75
+ ### Dependencies
76
+ - **Python**: pipen framework, pydantic (validation), pandas, scanpy
77
+ - **R**: Seurat, tidyverse, immunarch (check `docker/environment.yml` for conda env)
78
+ - **Containerization**: Use Dockerfile.full for complete environment with all R/Python deps
79
+
80
+ ## Critical Knowledge
81
+
82
+ ### Router System
83
+ The `router.py` determines workflow paths based on:
84
+ - Presence of TCR/BCR data in input (`has_tcr` flag)
85
+ - Sample groupings and batch structures
86
+ - See `docs/routes-tcr.png` and `docs/routes-notcr.png` for visual workflow diagrams
87
+
88
+ ### MCP Server Integration
89
+ - `immunopipe/mcp/` implements Model Context Protocol for AI agent interaction
90
+ - Allows AI agents to query pipeline state, generate configs, and understand process relationships
91
+ - Test MCP functionality with `tests/test_mcp_*.py`
92
+
93
+ ### Testing Strategy
94
+ - **Unit tests**: Individual process logic (`test_seuratpreparing.py`, `test_seuratclustering.py`)
95
+ - **Integration tests**: Sample data workflows in `tests/running/`
96
+ - **Config validation**: `test_mcp_options.py`, `test_mcp_toml_generator.py`
97
+
98
+ ### Documentation Generation
99
+ - Uses mkdocs (see `mkdocs.yml`)
100
+ - Process documentation auto-extracted from docstrings (see `test_doc_extractor.py`)
101
+ - Build docs: `mkdocs build` (requires deps from `docs/requirements.txt`)
102
+
103
+ ## Common Pitfalls
104
+ - **Process dependencies**: Ensure upstream processes are properly wired in pipeline.py before downstream processes
105
+ - **R/Python script paths**: Scripts must be findable relative to process execution context
106
+ - **Configuration schema**: When adding new process options, update `validate_config.py` schemas
107
+ - **Docker builds**: Use `Dockerfile.full` for complete reproducibility; base `Dockerfile` is minimal
108
+ - **TCR-specific processes**: Check router.py to ensure processes only run when TCR data is present
109
+
110
+ ## Key Files to Reference
111
+ - **Pipeline structure**: `immunopipe/pipeline.py`
112
+ - **Process catalog**: `immunopipe/processes.py` + `docs/processes/`
113
+ - **Workflow routing**: `immunopipe/router.py`, `docs/routes-*.png`
114
+ - **Dependencies**: `pyproject.toml`, `docker/environment*.yml`
115
+ - **User docs**: `docs/getting-started.md`, `docs/running.md`, `docs/preparing-input.md`
@@ -0,0 +1,101 @@
1
+ name: build
2
+
3
+ on: workflow_call
4
+
5
+ jobs:
6
+
7
+ docker-base:
8
+ runs-on: ubuntu-latest
9
+ if: "!contains(github.event.head_commit.message, '[wip]')"
10
+ steps:
11
+ - uses: actions/checkout@v6
12
+ with:
13
+ fetch-depth: 2
14
+ - name: Check if base files changed
15
+ id: check_changes
16
+ run: |
17
+ if [[ "${{ github.ref_name }}" == "dev" ]] && git diff --name-only HEAD~1 HEAD | grep -qE '(cleanup\.list|environment_base\.yml|Dockerfile\.base)$'; then
18
+ echo "changed=true" >> $GITHUB_OUTPUT
19
+ else
20
+ echo "changed=false" >> $GITHUB_OUTPUT
21
+ fi
22
+ - name: Set up QEMU
23
+ if: steps.check_changes.outputs.changed == 'true'
24
+ uses: docker/setup-qemu-action@v3
25
+ - name: Set up Docker Buildx
26
+ if: steps.check_changes.outputs.changed == 'true'
27
+ uses: docker/setup-buildx-action@v3
28
+ - name: Login to DockerHub
29
+ if: steps.check_changes.outputs.changed == 'true'
30
+ uses: docker/login-action@v3
31
+ with:
32
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
33
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
34
+ - name: Build and push
35
+ if: steps.check_changes.outputs.changed == 'true'
36
+ uses: docker/build-push-action@v6
37
+ with:
38
+ push: true
39
+ file: Dockerfile.base
40
+ tags: justold/immunopipe-base:latest
41
+
42
+ docker-rpkgs:
43
+ runs-on: ubuntu-latest
44
+ needs: docker-base
45
+ steps:
46
+ - uses: actions/checkout@v6
47
+ with:
48
+ fetch-depth: 2
49
+ - name: Check if rpkgs files changed
50
+ id: check_changes
51
+ run: |
52
+ if [[ "${{ github.ref_name }}" == "dev" ]] && git diff --name-only HEAD~1 HEAD | grep -qE '(cleanup\.list|environment_(base|rpkgs)\.yml|Dockerfile\.(base|rpkgs))$'; then
53
+ echo "changed=true" >> $GITHUB_OUTPUT
54
+ else
55
+ echo "changed=false" >> $GITHUB_OUTPUT
56
+ fi
57
+ - name: Set up QEMU
58
+ if: steps.check_changes.outputs.changed == 'true'
59
+ uses: docker/setup-qemu-action@v3
60
+ - name: Set up Docker Buildx
61
+ if: steps.check_changes.outputs.changed == 'true'
62
+ uses: docker/setup-buildx-action@v3
63
+ - name: Login to DockerHub
64
+ if: steps.check_changes.outputs.changed == 'true'
65
+ uses: docker/login-action@v3
66
+ with:
67
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
68
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
69
+ - name: Build and push
70
+ if: steps.check_changes.outputs.changed == 'true'
71
+ uses: docker/build-push-action@v6
72
+ with:
73
+ push: true
74
+ file: Dockerfile.rpkgs
75
+ tags: justold/immunopipe-rpkgs:latest
76
+
77
+ docker:
78
+ runs-on: ubuntu-latest
79
+ needs: docker-rpkgs
80
+ steps:
81
+ - name: Delete cache to save space
82
+ # https://github.com/orgs/community/discussions/25678#discussioncomment-5242449
83
+ run: rm -rf /opt/hostedtoolcache
84
+ - uses: actions/checkout@v6
85
+ - name: Set up QEMU
86
+ uses: docker/setup-qemu-action@v3
87
+ - name: Set up Docker Buildx
88
+ uses: docker/setup-buildx-action@v3
89
+ - name: Login to DockerHub
90
+ uses: docker/login-action@v3
91
+ with:
92
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
93
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
94
+ - name: Build and push
95
+ uses: docker/build-push-action@v6
96
+ with:
97
+ push: true
98
+ pull: false
99
+ # load: true
100
+ file: Dockerfile
101
+ tags: justold/immunopipe:${{ github.ref_name }}
@@ -0,0 +1,25 @@
1
+ name: deploy
2
+
3
+ # only when a version is released
4
+ on:
5
+ release:
6
+ types: [published]
7
+
8
+ jobs:
9
+
10
+ pypi:
11
+ runs-on: ubuntu-latest
12
+ strategy:
13
+ matrix:
14
+ python-version: ["3.12"]
15
+ steps:
16
+ - uses: actions/checkout@v6
17
+ - name: Install uv
18
+ uses: astral-sh/setup-uv@v8.0.0
19
+ with:
20
+ python-version: ${{ matrix.python-version }}
21
+ - name: Publish to PyPI
22
+ run: |
23
+ uv build
24
+ uv publish --username ${{ secrets.PYPI_USER }} --password ${{ secrets.PYPI_PASSWORD }}
25
+ if: success()
@@ -0,0 +1,30 @@
1
+ name: docs-dev
2
+
3
+ on: # on dev branch only
4
+ push:
5
+ branches:
6
+ - dev
7
+
8
+ jobs:
9
+ docs:
10
+ runs-on: ubuntu-latest
11
+ # if: github.ref == 'refs/heads/master'
12
+ strategy:
13
+ matrix:
14
+ python-version: ["3.12"]
15
+ steps:
16
+ - uses: actions/checkout@v6
17
+ - name: Install uv
18
+ uses: astral-sh/setup-uv@v8.0.0
19
+ with:
20
+ python-version: ${{ matrix.python-version }}
21
+ - name: Build process reference
22
+ run: make api
23
+ - name: Update docs
24
+ run: |
25
+ cp README.md docs/index.md
26
+ git config user.name github-actions
27
+ git config user.email github-actions@github.com
28
+ git fetch origin gh-pages --depth=1
29
+ uv run --group docs mike deploy --push --allow-empty dev
30
+ if: success()
@@ -0,0 +1,31 @@
1
+ name: docs-release
2
+
3
+ # on release only
4
+ on:
5
+ release:
6
+ types: [published]
7
+
8
+ jobs:
9
+ docs:
10
+ runs-on: ubuntu-latest
11
+ # if: github.ref == 'refs/heads/master'
12
+ strategy:
13
+ matrix:
14
+ python-version: ["3.12"]
15
+ steps:
16
+ - uses: actions/checkout@v6
17
+ - name: Install uv
18
+ uses: astral-sh/setup-uv@v8.0.0
19
+ with:
20
+ python-version: ${{ matrix.python-version }}
21
+ - name: Build process reference
22
+ run: make api
23
+ - name: Update docs
24
+ run: |
25
+ cp README.md docs/index.md
26
+ git config user.name github-actions
27
+ git config user.email github-actions@github.com
28
+ git fetch origin gh-pages --depth=1
29
+ uv run --group docs mike deploy --push --update-aliases --allow-empty ${{ github.ref_name }} latest
30
+ uv run --group docs mike set-default --push latest
31
+ if: success()
@@ -0,0 +1,188 @@
1
+ name: test
2
+
3
+ on: push
4
+ permissions:
5
+ contents: write
6
+ actions: write
7
+
8
+ jobs:
9
+
10
+ test:
11
+ runs-on: ubuntu-latest
12
+ if: github.ref_name == 'dev'
13
+ defaults:
14
+ run:
15
+ shell: bash -l {0}
16
+
17
+ steps:
18
+ - name: Delete cache to save space
19
+ # https://github.com/orgs/community/discussions/25678#discussioncomment-5242449
20
+ run: rm -rf /opt/hostedtoolcache
21
+
22
+ - uses: actions/checkout@v6
23
+ with:
24
+ fetch-depth: 0
25
+
26
+ - uses: chetan/git-restore-mtime-action@v2
27
+
28
+ - uses: conda-incubator/setup-miniconda@v3
29
+ with:
30
+ python-version: "3.12"
31
+ auto-update-conda: true
32
+ activate-environment: immunopipe
33
+ channels: conda-forge,defaults
34
+
35
+ - name: Change conda envs permissions
36
+ # https://github.com/actions/cache/issues/133
37
+ run: |
38
+ sudo chown -R $USER $CONDA/envs
39
+ sudo chmod -R 0777 $CONDA/envs
40
+
41
+ - name: Restore conda environment
42
+ id: restore-conda
43
+ uses: actions/cache/restore@v5
44
+ with:
45
+ path: ${{ env.CONDA }}/envs/immunopipe
46
+ key: conda-${{ hashFiles('docker/environment_base.yml') }}-${{ hashFiles('docker/environment_rpkgs.yml') }}-${{ env.CACHE_NUMBER }}
47
+ env:
48
+ TAR_OPTIONS: "--no-same-owner --no-same-permissions"
49
+ CACHE_NUMBER: 1
50
+
51
+ - name: Create conda environment (if not restored)
52
+ if: steps.restore-conda.outputs.cache-hit != 'true'
53
+ run: |
54
+ conda env create -y -f docker/environment_base.yml --name immunopipe
55
+ conda activate immunopipe
56
+ conda env update -f docker/environment_rpkgs.yml --name immunopipe
57
+
58
+ - name: Cache conda environment
59
+ id: cache-conda
60
+ if: steps.restore-conda.outputs.cache-hit != 'true'
61
+ uses: actions/cache/save@v5
62
+ with:
63
+ path: ${{ env.CONDA }}/envs/immunopipe
64
+ key: ${{ steps.restore-conda.outputs.cache-primary-key }}
65
+
66
+ - name: List conda information
67
+ run: |
68
+ conda info
69
+ conda list
70
+ conda config --show-sources
71
+ conda config --show
72
+
73
+ - name: Install immunopipe
74
+ run: |
75
+ uv pip install --system -e ".[cli-gbatch]"
76
+
77
+ - name: Check if some packages can be imported
78
+ run: |
79
+ echo "Checking scanpy ..."
80
+ python -c "import scanpy, importlib.metadata; print(f'scanpy version: {importlib.metadata.version('scanpy')}')"
81
+ echo "Checking liana ..."
82
+ python -c "import liana, importlib.metadata; print(f'liana version: {importlib.metadata.version('liana')}')"
83
+ echo "Checking celltypist2 ..."
84
+ python -c "import celltypist, importlib.metadata; print(f'celltypist2 version: {importlib.metadata.version('celltypist2')}')"
85
+ echo "Checking BioPython ..."
86
+ python -c "import Bio, importlib.metadata; print(f'BioPython version: {importlib.metadata.version('BioPython')}')"
87
+ echo "Checking keras ..."
88
+ python -c "import keras, importlib.metadata; print(f'keras version: {importlib.metadata.version('keras')}')"
89
+ echo "Checking tensorflow ..."
90
+ python -c "import tensorflow, importlib.metadata; print(f'tensorflow version: {importlib.metadata.version('tensorflow')}')"
91
+ echo "Checking umap-learn ..."
92
+ python -c "import umap, importlib.metadata; print(f'umap-learn version: {importlib.metadata.version('umap-learn')}')"
93
+ echo "Checking stringfish (R) ..."
94
+ R -e "library(stringfish); packageVersion('stringfish')"
95
+
96
+ - name: Check if immunopipe is installed successfully
97
+ run: |
98
+ if ! immunopipe >/dev/null; then
99
+ echo "immunopipe is not installed successfully"
100
+ # print the error
101
+ immunopipe
102
+ exit 1
103
+ else # test if the TEST_STRING is in the help message
104
+ if ! immunopipe | grep -q "$TEST_STRING"; then
105
+ echo "immunopipe is not installed successfully"
106
+ # print the error
107
+ immunopipe
108
+ exit 1
109
+ fi
110
+ fi
111
+ env:
112
+ TEST_STRING: "Integrative analysis for scRNA-seq and scTCR-/scBCR-seq data"
113
+
114
+ - name: Restore running data
115
+ id: restore-running
116
+ uses: actions/cache/restore@v5
117
+ with:
118
+ path: tests/running/
119
+ key: tests-running-${{ env.CACHE_NUMBER }}
120
+ env:
121
+ TAR_OPTIONS: "--no-same-owner --no-same-permissions --skip-old-files"
122
+ ACTIONS_CACHE_SERVICE_V2: true
123
+ CACHE_NUMBER: 1
124
+
125
+ - name: Download input data (if not restored)
126
+ if: steps.restore-running.outputs.cache-hit != 'true'
127
+ run: make test-data
128
+
129
+ - name: Run tests
130
+ run: make test
131
+
132
+ - name: Add README.md to tests/running/output
133
+ run: |
134
+ echo "# Tests output for immunopipe" > $OUTPUT_DIR/README.md
135
+ echo "" >> $OUTPUT_DIR/README.md
136
+ echo "This directory contains the output of the tests for immunopipe" >> $OUTPUT_DIR/README.md
137
+ echo "" >> $OUTPUT_DIR/README.md
138
+ echo "The output can be used for documentation purposes" >> $OUTPUT_DIR/README.md
139
+ env:
140
+ OUTPUT_DIR: tests/running/output
141
+
142
+ - name: Create .gitignore for tests/running/output
143
+ run: |
144
+ echo "**/*.RDS" > $OUTPUT_DIR/.gitignore
145
+ echo "**/*.rds" >> $OUTPUT_DIR/.gitignore
146
+ echo "**/*.qs" >> $OUTPUT_DIR/.gitignore
147
+ echo "**/*.qs2" >> $OUTPUT_DIR/.gitignore
148
+ echo "**/*.json" >> $OUTPUT_DIR/.gitignore
149
+ echo "**/*.txt" >> $OUTPUT_DIR/.gitignore
150
+ echo "**/*.tsv" >> $OUTPUT_DIR/.gitignore
151
+ echo "**/*.pdf" >> $OUTPUT_DIR/.gitignore
152
+ env:
153
+ OUTPUT_DIR: tests/running/output
154
+
155
+ - name: Deploy output to tests-output branch
156
+ uses: JamesIves/github-pages-deploy-action@v4
157
+ with:
158
+ folder: tests/running/output
159
+ branch: tests-output
160
+ token: ${{ secrets.GITHUB_TOKEN }}
161
+ force: true
162
+
163
+ - name: Delete old test running data cache
164
+ env:
165
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
166
+ # if: steps.restore-running.outputs.cache-hit != 'true'
167
+ # Using `--repo` makes it so that this step doesn't require checking out the
168
+ # repo first.
169
+ run: gh cache delete --repo ${{ github.repository }} ${{ steps.restore-running.outputs.cache-primary-key }}
170
+
171
+ - name: Cache running data
172
+ id: cache-running
173
+ if: always()
174
+ uses: actions/cache/save@v5
175
+ with:
176
+ path: tests/running/
177
+ key: ${{ steps.restore-running.outputs.cache-primary-key }}
178
+ env:
179
+ ACTIONS_CACHE_SERVICE_V2: true
180
+
181
+ build:
182
+ needs: [test]
183
+ if: |
184
+ always()
185
+ && !contains(needs.*.result, 'failure')
186
+ && !contains(needs.*.result, 'cancelled')
187
+ uses: ./.github/workflows/build.yml
188
+ secrets: inherit