flowcellar 0.1.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 (357) hide show
  1. flowcellar-0.1.0/.gitignore +22 -0
  2. flowcellar-0.1.0/CHANGELOG.md +201 -0
  3. flowcellar-0.1.0/LICENSE +674 -0
  4. flowcellar-0.1.0/PKG-INFO +506 -0
  5. flowcellar-0.1.0/README.md +458 -0
  6. flowcellar-0.1.0/THIRD_PARTY_NOTICES.md +85 -0
  7. flowcellar-0.1.0/catalogue/metrics_nanopore.yaml +10405 -0
  8. flowcellar-0.1.0/catalogue/metrics_singlecell_spatial.yaml +2075 -0
  9. flowcellar-0.1.0/docs/commands.md +400 -0
  10. flowcellar-0.1.0/docs/configuration.md +230 -0
  11. flowcellar-0.1.0/docs/development.md +124 -0
  12. flowcellar-0.1.0/docs/img/analysis.png +0 -0
  13. flowcellar-0.1.0/docs/img/compare.png +0 -0
  14. flowcellar-0.1.0/docs/img/figures-alignment.png +0 -0
  15. flowcellar-0.1.0/docs/img/figures-rna-spatial.png +0 -0
  16. flowcellar-0.1.0/docs/img/figures-run.png +0 -0
  17. flowcellar-0.1.0/docs/img/flowcell.png +0 -0
  18. flowcellar-0.1.0/docs/img/home.png +0 -0
  19. flowcellar-0.1.0/docs/img/merged.png +0 -0
  20. flowcellar-0.1.0/docs/img/overview-dark.svg +99 -0
  21. flowcellar-0.1.0/docs/img/overview-light.svg +99 -0
  22. flowcellar-0.1.0/docs/img/pdf.png +0 -0
  23. flowcellar-0.1.0/docs/img/run.png +0 -0
  24. flowcellar-0.1.0/docs/index.md +51 -0
  25. flowcellar-0.1.0/docs/library.md +181 -0
  26. flowcellar-0.1.0/docs/metrics.md +443 -0
  27. flowcellar-0.1.0/docs/quick-start.md +244 -0
  28. flowcellar-0.1.0/docs/releasing.md +94 -0
  29. flowcellar-0.1.0/hatch_build.py +148 -0
  30. flowcellar-0.1.0/pyproject.toml +105 -0
  31. flowcellar-0.1.0/src/flowcellar/__init__.py +9 -0
  32. flowcellar-0.1.0/src/flowcellar/__main__.py +4 -0
  33. flowcellar-0.1.0/src/flowcellar/_version.py +1 -0
  34. flowcellar-0.1.0/src/flowcellar/aggregates/__init__.py +11 -0
  35. flowcellar-0.1.0/src/flowcellar/aggregates/build.py +151 -0
  36. flowcellar-0.1.0/src/flowcellar/aggregates/derive.py +109 -0
  37. flowcellar-0.1.0/src/flowcellar/aggregates/merge.py +362 -0
  38. flowcellar-0.1.0/src/flowcellar/catalogue/__init__.py +63 -0
  39. flowcellar-0.1.0/src/flowcellar/catalogue/metrics_nanopore.json +1 -0
  40. flowcellar-0.1.0/src/flowcellar/cli/__init__.py +97 -0
  41. flowcellar-0.1.0/src/flowcellar/cli/_options.py +25 -0
  42. flowcellar-0.1.0/src/flowcellar/cli/analysis.py +317 -0
  43. flowcellar-0.1.0/src/flowcellar/cli/discover.py +168 -0
  44. flowcellar-0.1.0/src/flowcellar/cli/doctor.py +31 -0
  45. flowcellar-0.1.0/src/flowcellar/cli/hub.py +47 -0
  46. flowcellar-0.1.0/src/flowcellar/cli/init.py +41 -0
  47. flowcellar-0.1.0/src/flowcellar/cli/ls.py +94 -0
  48. flowcellar-0.1.0/src/flowcellar/cli/recompute.py +52 -0
  49. flowcellar-0.1.0/src/flowcellar/cli/rm.py +21 -0
  50. flowcellar-0.1.0/src/flowcellar/cli/run.py +333 -0
  51. flowcellar-0.1.0/src/flowcellar/cli/scan.py +60 -0
  52. flowcellar-0.1.0/src/flowcellar/cli/schema.py +25 -0
  53. flowcellar-0.1.0/src/flowcellar/cli/serve.py +46 -0
  54. flowcellar-0.1.0/src/flowcellar/cli/show.py +109 -0
  55. flowcellar-0.1.0/src/flowcellar/cli/validate.py +44 -0
  56. flowcellar-0.1.0/src/flowcellar/config/__init__.py +4 -0
  57. flowcellar-0.1.0/src/flowcellar/config/defaults.toml +51 -0
  58. flowcellar-0.1.0/src/flowcellar/config/loader.py +369 -0
  59. flowcellar-0.1.0/src/flowcellar/contracts.py +159 -0
  60. flowcellar-0.1.0/src/flowcellar/discovery/__init__.py +141 -0
  61. flowcellar-0.1.0/src/flowcellar/discovery/guard.py +208 -0
  62. flowcellar-0.1.0/src/flowcellar/discovery/patterns.py +209 -0
  63. flowcellar-0.1.0/src/flowcellar/discovery/walk.py +348 -0
  64. flowcellar-0.1.0/src/flowcellar/engine/__init__.py +1 -0
  65. flowcellar-0.1.0/src/flowcellar/engine/api.py +119 -0
  66. flowcellar-0.1.0/src/flowcellar/engine/assemble.py +363 -0
  67. flowcellar-0.1.0/src/flowcellar/engine/baselines.py +128 -0
  68. flowcellar-0.1.0/src/flowcellar/engine/card.py +250 -0
  69. flowcellar-0.1.0/src/flowcellar/engine/copy_pending.py +110 -0
  70. flowcellar-0.1.0/src/flowcellar/engine/flowcell_use.py +85 -0
  71. flowcellar-0.1.0/src/flowcellar/engine/identity.py +351 -0
  72. flowcellar-0.1.0/src/flowcellar/engine/limits.py +135 -0
  73. flowcellar-0.1.0/src/flowcellar/engine/passes.py +213 -0
  74. flowcellar-0.1.0/src/flowcellar/engine/status.py +728 -0
  75. flowcellar-0.1.0/src/flowcellar/library/__init__.py +4 -0
  76. flowcellar-0.1.0/src/flowcellar/library/api.py +61 -0
  77. flowcellar-0.1.0/src/flowcellar/library/cards.py +69 -0
  78. flowcellar-0.1.0/src/flowcellar/library/draft.py +247 -0
  79. flowcellar-0.1.0/src/flowcellar/library/index.py +323 -0
  80. flowcellar-0.1.0/src/flowcellar/library/layout.py +69 -0
  81. flowcellar-0.1.0/src/flowcellar/library/lease.py +248 -0
  82. flowcellar-0.1.0/src/flowcellar/library/maintain.py +347 -0
  83. flowcellar-0.1.0/src/flowcellar/library/projects.py +84 -0
  84. flowcellar-0.1.0/src/flowcellar/library/query.py +382 -0
  85. flowcellar-0.1.0/src/flowcellar/library/scan.py +1770 -0
  86. flowcellar-0.1.0/src/flowcellar/library/store.py +225 -0
  87. flowcellar-0.1.0/src/flowcellar/library/trash.py +63 -0
  88. flowcellar-0.1.0/src/flowcellar/model/__init__.py +1 -0
  89. flowcellar-0.1.0/src/flowcellar/model/axes.py +200 -0
  90. flowcellar-0.1.0/src/flowcellar/model/bundle.py +143 -0
  91. flowcellar-0.1.0/src/flowcellar/model/partial.py +96 -0
  92. flowcellar-0.1.0/src/flowcellar/model/runfolder.py +83 -0
  93. flowcellar-0.1.0/src/flowcellar/model/runkey.py +98 -0
  94. flowcellar-0.1.0/src/flowcellar/model/schema.py +46 -0
  95. flowcellar-0.1.0/src/flowcellar/model/schemas/bundle-0.1.1.schema.json +3713 -0
  96. flowcellar-0.1.0/src/flowcellar/model/status.py +97 -0
  97. flowcellar-0.1.0/src/flowcellar/modules/__init__.py +0 -0
  98. flowcellar-0.1.0/src/flowcellar/modules/common.py +73 -0
  99. flowcellar-0.1.0/src/flowcellar/modules/dyn.py +124 -0
  100. flowcellar-0.1.0/src/flowcellar/modules/fc.py +390 -0
  101. flowcellar-0.1.0/src/flowcellar/modules/len_est.py +74 -0
  102. flowcellar-0.1.0/src/flowcellar/modules/run.py +88 -0
  103. flowcellar-0.1.0/src/flowcellar/modules/yield_.py +120 -0
  104. flowcellar-0.1.0/src/flowcellar/readdata/__init__.py +1 -0
  105. flowcellar-0.1.0/src/flowcellar/readdata/_pool.py +87 -0
  106. flowcellar-0.1.0/src/flowcellar/readdata/acc.py +161 -0
  107. flowcellar-0.1.0/src/flowcellar/readdata/alnacc.py +572 -0
  108. flowcellar-0.1.0/src/flowcellar/readdata/alnpass.py +85 -0
  109. flowcellar-0.1.0/src/flowcellar/readdata/api.py +189 -0
  110. flowcellar-0.1.0/src/flowcellar/readdata/bam.py +851 -0
  111. flowcellar-0.1.0/src/flowcellar/readdata/bamindex.py +149 -0
  112. flowcellar-0.1.0/src/flowcellar/readdata/cards.py +82 -0
  113. flowcellar-0.1.0/src/flowcellar/readdata/checks.py +312 -0
  114. flowcellar-0.1.0/src/flowcellar/readdata/copy_pending.py +73 -0
  115. flowcellar-0.1.0/src/flowcellar/readdata/fate.py +341 -0
  116. flowcellar-0.1.0/src/flowcellar/readdata/finder.py +147 -0
  117. flowcellar-0.1.0/src/flowcellar/readdata/libprep.py +97 -0
  118. flowcellar-0.1.0/src/flowcellar/readdata/link.py +486 -0
  119. flowcellar-0.1.0/src/flowcellar/readdata/passes.py +149 -0
  120. flowcellar-0.1.0/src/flowcellar/readdata/patterns.py +230 -0
  121. flowcellar-0.1.0/src/flowcellar/readdata/pychopper.py +431 -0
  122. flowcellar-0.1.0/src/flowcellar/readdata/readtable.py +416 -0
  123. flowcellar-0.1.0/src/flowcellar/readdata/record.py +159 -0
  124. flowcellar-0.1.0/src/flowcellar/readdata/reference.py +139 -0
  125. flowcellar-0.1.0/src/flowcellar/readdata/rnacomp.py +329 -0
  126. flowcellar-0.1.0/src/flowcellar/readdata/sample_sheet.py +153 -0
  127. flowcellar-0.1.0/src/flowcellar/readdata/saturation.py +110 -0
  128. flowcellar-0.1.0/src/flowcellar/readdata/sections.py +892 -0
  129. flowcellar-0.1.0/src/flowcellar/readdata/sections_align.py +644 -0
  130. flowcellar-0.1.0/src/flowcellar/readdata/tables.py +262 -0
  131. flowcellar-0.1.0/src/flowcellar/report/__init__.py +1 -0
  132. flowcellar-0.1.0/src/flowcellar/report/api.py +54 -0
  133. flowcellar-0.1.0/src/flowcellar/report/html.py +342 -0
  134. flowcellar-0.1.0/src/flowcellar/report/hub.py +159 -0
  135. flowcellar-0.1.0/src/flowcellar/report/index_one.py +144 -0
  136. flowcellar-0.1.0/src/flowcellar/report/served.py +67 -0
  137. flowcellar-0.1.0/src/flowcellar/sc/__init__.py +57 -0
  138. flowcellar-0.1.0/src/flowcellar/sc/axes.py +211 -0
  139. flowcellar-0.1.0/src/flowcellar/sc/catalogue.json +1 -0
  140. flowcellar-0.1.0/src/flowcellar/sc/catalogue.py +51 -0
  141. flowcellar-0.1.0/src/flowcellar/sc/check.py +57 -0
  142. flowcellar-0.1.0/src/flowcellar/sc/collect.py +299 -0
  143. flowcellar-0.1.0/src/flowcellar/sc/collect_sr.py +450 -0
  144. flowcellar-0.1.0/src/flowcellar/sc/collect_wf.py +479 -0
  145. flowcellar-0.1.0/src/flowcellar/sc/detect.py +303 -0
  146. flowcellar-0.1.0/src/flowcellar/sc/judge.py +269 -0
  147. flowcellar-0.1.0/src/flowcellar/sc/link.py +326 -0
  148. flowcellar-0.1.0/src/flowcellar/sc/listing.py +144 -0
  149. flowcellar-0.1.0/src/flowcellar/sc/maps.py +181 -0
  150. flowcellar-0.1.0/src/flowcellar/sc/readpass.py +416 -0
  151. flowcellar-0.1.0/src/flowcellar/sc/report.py +230 -0
  152. flowcellar-0.1.0/src/flowcellar/sc/scan.py +176 -0
  153. flowcellar-0.1.0/src/flowcellar/sc/spaceranger.py +483 -0
  154. flowcellar-0.1.0/src/flowcellar/sc/store.py +537 -0
  155. flowcellar-0.1.0/src/flowcellar/sc/wfsc.py +419 -0
  156. flowcellar-0.1.0/src/flowcellar/serve/__init__.py +4 -0
  157. flowcellar-0.1.0/src/flowcellar/serve/server.py +153 -0
  158. flowcellar-0.1.0/src/flowcellar/sources/__init__.py +0 -0
  159. flowcellar-0.1.0/src/flowcellar/sources/minknow.py +455 -0
  160. flowcellar-0.1.0/src/flowcellar/sources/porescan.py +218 -0
  161. flowcellar-0.1.0/src/flowcellar/sources/seqsummary.py +450 -0
  162. flowcellar-0.1.0/src/flowcellar/sources/workers.py +244 -0
  163. flowcellar-0.1.0/src/flowcellar/testing/__init__.py +1 -0
  164. flowcellar-0.1.0/src/flowcellar/testing/demo.py +1217 -0
  165. flowcellar-0.1.0/src/flowcellar/testing/demo_spatial.py +370 -0
  166. flowcellar-0.1.0/src/flowcellar/testing/fixtures.py +459 -0
  167. flowcellar-0.1.0/src/flowcellar/testing/libprep.py +252 -0
  168. flowcellar-0.1.0/src/flowcellar/testing/minknow_variants.py +384 -0
  169. flowcellar-0.1.0/src/flowcellar/testing/readdata.py +744 -0
  170. flowcellar-0.1.0/src/flowcellar/testing/sc.py +817 -0
  171. flowcellar-0.1.0/src/flowcellar/testing/trees.py +175 -0
  172. flowcellar-0.1.0/src/flowcellar/util/__init__.py +1 -0
  173. flowcellar-0.1.0/src/flowcellar/util/atomic.py +112 -0
  174. flowcellar-0.1.0/src/flowcellar/util/errors.py +72 -0
  175. flowcellar-0.1.0/src/flowcellar/util/fingerprint.py +49 -0
  176. flowcellar-0.1.0/src/flowcellar/util/log.py +50 -0
  177. flowcellar-0.1.0/src/flowcellar/util/text.py +43 -0
  178. flowcellar-0.1.0/src/flowcellar/util/timeutil.py +52 -0
  179. flowcellar-0.1.0/src/flowcellar/viewer_dist/favicon.svg +1 -0
  180. flowcellar-0.1.0/src/flowcellar/viewer_dist/manifest.json +37 -0
  181. flowcellar-0.1.0/src/flowcellar/viewer_dist/template.html +12 -0
  182. flowcellar-0.1.0/src/flowcellar/viewer_dist/viewer.core.js +3 -0
  183. flowcellar-0.1.0/src/flowcellar/viewer_dist/viewer.css +2151 -0
  184. flowcellar-0.1.0/tests/conftest.py +19 -0
  185. flowcellar-0.1.0/tests/core/test_aggregates.py +151 -0
  186. flowcellar-0.1.0/tests/core/test_catalogue.py +38 -0
  187. flowcellar-0.1.0/tests/core/test_cli.py +73 -0
  188. flowcellar-0.1.0/tests/core/test_model.py +184 -0
  189. flowcellar-0.1.0/tests/core/test_seams.py +59 -0
  190. flowcellar-0.1.0/tests/core/test_util.py +65 -0
  191. flowcellar-0.1.0/tests/engine/conftest.py +57 -0
  192. flowcellar-0.1.0/tests/engine/engine_support.py +246 -0
  193. flowcellar-0.1.0/tests/engine/test_identity.py +187 -0
  194. flowcellar-0.1.0/tests/engine/test_passes.py +363 -0
  195. flowcellar-0.1.0/tests/engine/test_quick_and_full.py +246 -0
  196. flowcellar-0.1.0/tests/engine/test_run_command.py +177 -0
  197. flowcellar-0.1.0/tests/engine/test_status_checks.py +368 -0
  198. flowcellar-0.1.0/tests/engine/test_status_history.py +326 -0
  199. flowcellar-0.1.0/tests/fixtures/test_fixture_generator.py +105 -0
  200. flowcellar-0.1.0/tests/integration/test_end_to_end.py +395 -0
  201. flowcellar-0.1.0/tests/integration/test_example.py +167 -0
  202. flowcellar-0.1.0/tests/integration/test_run_with_config.py +56 -0
  203. flowcellar-0.1.0/tests/integration/test_wheel.py +65 -0
  204. flowcellar-0.1.0/tests/library/conftest.py +72 -0
  205. flowcellar-0.1.0/tests/library/library_fakes.py +405 -0
  206. flowcellar-0.1.0/tests/library/library_helpers.py +41 -0
  207. flowcellar-0.1.0/tests/library/test_library_commands.py +367 -0
  208. flowcellar-0.1.0/tests/library/test_library_config.py +151 -0
  209. flowcellar-0.1.0/tests/library/test_library_discovery.py +283 -0
  210. flowcellar-0.1.0/tests/library/test_library_index.py +183 -0
  211. flowcellar-0.1.0/tests/library/test_library_lease.py +90 -0
  212. flowcellar-0.1.0/tests/library/test_library_pass_versions.py +157 -0
  213. flowcellar-0.1.0/tests/library/test_library_query.py +67 -0
  214. flowcellar-0.1.0/tests/library/test_library_regressions.py +381 -0
  215. flowcellar-0.1.0/tests/library/test_library_scan.py +809 -0
  216. flowcellar-0.1.0/tests/library/test_library_seams.py +184 -0
  217. flowcellar-0.1.0/tests/library/test_library_serve.py +129 -0
  218. flowcellar-0.1.0/tests/library/test_library_with_real_parts.py +138 -0
  219. flowcellar-0.1.0/tests/readdata/conftest.py +55 -0
  220. flowcellar-0.1.0/tests/readdata/rd_helpers.py +66 -0
  221. flowcellar-0.1.0/tests/readdata/test_align_pass.py +461 -0
  222. flowcellar-0.1.0/tests/readdata/test_align_sections.py +471 -0
  223. flowcellar-0.1.0/tests/readdata/test_bam_pass.py +326 -0
  224. flowcellar-0.1.0/tests/readdata/test_checks.py +212 -0
  225. flowcellar-0.1.0/tests/readdata/test_libprep_pychopper.py +326 -0
  226. flowcellar-0.1.0/tests/readdata/test_libprep_readtable.py +462 -0
  227. flowcellar-0.1.0/tests/readdata/test_libprep_scan.py +125 -0
  228. flowcellar-0.1.0/tests/readdata/test_link.py +457 -0
  229. flowcellar-0.1.0/tests/readdata/test_sections.py +658 -0
  230. flowcellar-0.1.0/tests/readdata/test_tables.py +151 -0
  231. flowcellar-0.1.0/tests/release/test_release_files.py +499 -0
  232. flowcellar-0.1.0/tests/sc/__init__.py +0 -0
  233. flowcellar-0.1.0/tests/sc/conftest.py +64 -0
  234. flowcellar-0.1.0/tests/sc/test_cli_and_imports.py +163 -0
  235. flowcellar-0.1.0/tests/sc/test_detect.py +74 -0
  236. flowcellar-0.1.0/tests/sc/test_judge.py +198 -0
  237. flowcellar-0.1.0/tests/sc/test_library.py +211 -0
  238. flowcellar-0.1.0/tests/sc/test_link.py +108 -0
  239. flowcellar-0.1.0/tests/sc/test_readpass.py +73 -0
  240. flowcellar-0.1.0/tests/sc/test_spaceranger.py +206 -0
  241. flowcellar-0.1.0/tests/sc/test_wf.py +149 -0
  242. flowcellar-0.1.0/tests/test_repository_rules.py +63 -0
  243. flowcellar-0.1.0/tests/vectors/query/flags_and_errors.json +682 -0
  244. flowcellar-0.1.0/tests/vectors/query/numbers_and_dates.json +688 -0
  245. flowcellar-0.1.0/tests/vectors/query/projects_and_verdicts.json +479 -0
  246. flowcellar-0.1.0/tests/vectors/query/text_and_enums.json +748 -0
  247. flowcellar-0.1.0/tests/viewer/conftest.py +38 -0
  248. flowcellar-0.1.0/tests/viewer/test_viewer_align.py +76 -0
  249. flowcellar-0.1.0/tests/viewer/test_viewer_analysis.py +115 -0
  250. flowcellar-0.1.0/tests/viewer/test_viewer_browser.py +36 -0
  251. flowcellar-0.1.0/tests/viewer/test_viewer_build.py +99 -0
  252. flowcellar-0.1.0/tests/viewer/test_viewer_close2.py +169 -0
  253. flowcellar-0.1.0/tests/viewer/test_viewer_libprep.py +76 -0
  254. flowcellar-0.1.0/tests/viewer/test_viewer_pages.py +515 -0
  255. flowcellar-0.1.0/tests/viewer/test_viewer_print.py +84 -0
  256. flowcellar-0.1.0/tests/viewer/test_viewer_query_vectors.py +25 -0
  257. flowcellar-0.1.0/tests/viewer/test_viewer_units.py +22 -0
  258. flowcellar-0.1.0/tests/viewer/viewer_fake_library.py +51 -0
  259. flowcellar-0.1.0/tests/viewer/viewer_make_fixture.py +57 -0
  260. flowcellar-0.1.0/tests/viewer/viewer_print_fixture.py +111 -0
  261. flowcellar-0.1.0/tests/viewer/viewer_serve_stub.py +60 -0
  262. flowcellar-0.1.0/tests/viewer/viewer_synth.py +1075 -0
  263. flowcellar-0.1.0/tools/build_catalogue.py +55 -0
  264. flowcellar-0.1.0/tools/build_docs.py +442 -0
  265. flowcellar-0.1.0/tools/build_sc_catalogue.py +71 -0
  266. flowcellar-0.1.0/tools/build_viewer.py +53 -0
  267. flowcellar-0.1.0/tools/check_dist.py +399 -0
  268. flowcellar-0.1.0/tools/licence_check.py +122 -0
  269. flowcellar-0.1.0/tools/make_demo.py +13 -0
  270. flowcellar-0.1.0/tools/make_fixtures.py +11 -0
  271. flowcellar-0.1.0/tools/make_readme_pictures.py +294 -0
  272. flowcellar-0.1.0/tools/readme_illustration.py +166 -0
  273. flowcellar-0.1.0/tools/readme_shots.mjs +111 -0
  274. flowcellar-0.1.0/tools/smoke_test.py +313 -0
  275. flowcellar-0.1.0/viewer/README.md +93 -0
  276. flowcellar-0.1.0/viewer/brand/favicon-16.png +0 -0
  277. flowcellar-0.1.0/viewer/brand/favicon-32.png +0 -0
  278. flowcellar-0.1.0/viewer/brand/favicon-48.png +0 -0
  279. flowcellar-0.1.0/viewer/brand/favicon.ico +0 -0
  280. flowcellar-0.1.0/viewer/brand/favicon.svg +1 -0
  281. flowcellar-0.1.0/viewer/brand/flowcellar-clearspace.svg +1 -0
  282. flowcellar-0.1.0/viewer/brand/flowcellar-lockup-dark.svg +1 -0
  283. flowcellar-0.1.0/viewer/brand/flowcellar-lockup-mono-black.svg +1 -0
  284. flowcellar-0.1.0/viewer/brand/flowcellar-lockup-mono-white.svg +1 -0
  285. flowcellar-0.1.0/viewer/brand/flowcellar-lockup-stacked-dark.svg +1 -0
  286. flowcellar-0.1.0/viewer/brand/flowcellar-lockup-stacked-mono-black.svg +1 -0
  287. flowcellar-0.1.0/viewer/brand/flowcellar-lockup-stacked-mono-white.svg +1 -0
  288. flowcellar-0.1.0/viewer/brand/flowcellar-lockup-stacked.svg +1 -0
  289. flowcellar-0.1.0/viewer/brand/flowcellar-lockup.svg +1 -0
  290. flowcellar-0.1.0/viewer/brand/flowcellar-mark-dark.svg +1 -0
  291. flowcellar-0.1.0/viewer/brand/flowcellar-mark-mono-black.svg +1 -0
  292. flowcellar-0.1.0/viewer/brand/flowcellar-mark-mono-white.svg +1 -0
  293. flowcellar-0.1.0/viewer/brand/flowcellar-mark-small-dark.svg +1 -0
  294. flowcellar-0.1.0/viewer/brand/flowcellar-mark-small-mono-black.svg +1 -0
  295. flowcellar-0.1.0/viewer/brand/flowcellar-mark-small.svg +1 -0
  296. flowcellar-0.1.0/viewer/brand/flowcellar-mark.svg +1 -0
  297. flowcellar-0.1.0/viewer/brand/flowcellar-tile-180.png +0 -0
  298. flowcellar-0.1.0/viewer/brand/flowcellar-tile.svg +1 -0
  299. flowcellar-0.1.0/viewer/brand/flowcellar-wordmark-dark.svg +1 -0
  300. flowcellar-0.1.0/viewer/brand/flowcellar-wordmark-mono-black.svg +1 -0
  301. flowcellar-0.1.0/viewer/brand/flowcellar-wordmark-mono-white.svg +1 -0
  302. flowcellar-0.1.0/viewer/brand/flowcellar-wordmark.svg +1 -0
  303. flowcellar-0.1.0/viewer/build.mjs +136 -0
  304. flowcellar-0.1.0/viewer/package-lock.json +577 -0
  305. flowcellar-0.1.0/viewer/package.json +22 -0
  306. flowcellar-0.1.0/viewer/src/analysis/Analyses.jsx +147 -0
  307. flowcellar-0.1.0/viewer/src/analysis/Analysis.jsx +464 -0
  308. flowcellar-0.1.0/viewer/src/analysis/SpatialMap.jsx +205 -0
  309. flowcellar-0.1.0/viewer/src/analysis/sc.js +190 -0
  310. flowcellar-0.1.0/viewer/src/charts/ChartPanel.jsx +189 -0
  311. flowcellar-0.1.0/viewer/src/charts/Grid.jsx +19 -0
  312. flowcellar-0.1.0/viewer/src/charts/columns.js +4 -0
  313. flowcellar-0.1.0/viewer/src/charts/kit.js +559 -0
  314. flowcellar-0.1.0/viewer/src/charts/layouts.js +31 -0
  315. flowcellar-0.1.0/viewer/src/charts/theme.js +52 -0
  316. flowcellar-0.1.0/viewer/src/compare/Compare.jsx +190 -0
  317. flowcellar-0.1.0/viewer/src/core/data.js +176 -0
  318. flowcellar-0.1.0/viewer/src/core/derive.js +284 -0
  319. flowcellar-0.1.0/viewer/src/core/derive_align.js +143 -0
  320. flowcellar-0.1.0/viewer/src/core/format.js +132 -0
  321. flowcellar-0.1.0/viewer/src/core/labels.js +61 -0
  322. flowcellar-0.1.0/viewer/src/core/print.js +163 -0
  323. flowcellar-0.1.0/viewer/src/core/state.js +92 -0
  324. flowcellar-0.1.0/viewer/src/core/values.js +27 -0
  325. flowcellar-0.1.0/viewer/src/flowcell/FlowCell.jsx +121 -0
  326. flowcellar-0.1.0/viewer/src/home/Home.jsx +200 -0
  327. flowcellar-0.1.0/viewer/src/hub/Hub.jsx +256 -0
  328. flowcellar-0.1.0/viewer/src/hub/columns.js +59 -0
  329. flowcellar-0.1.0/viewer/src/hub/query.js +167 -0
  330. flowcellar-0.1.0/viewer/src/main.jsx +120 -0
  331. flowcellar-0.1.0/viewer/src/projects/Projects.jsx +111 -0
  332. flowcellar-0.1.0/viewer/src/run/Run.jsx +343 -0
  333. flowcellar-0.1.0/viewer/src/run/alignment.jsx +499 -0
  334. flowcellar-0.1.0/viewer/src/run/common.js +159 -0
  335. flowcellar-0.1.0/viewer/src/run/details.jsx +80 -0
  336. flowcellar-0.1.0/viewer/src/run/health.jsx +262 -0
  337. flowcellar-0.1.0/viewer/src/run/pychopper.jsx +205 -0
  338. flowcellar-0.1.0/viewer/src/run/readdata.jsx +269 -0
  339. flowcellar-0.1.0/viewer/src/run/rnacomp.jsx +165 -0
  340. flowcellar-0.1.0/viewer/src/run/section.jsx +63 -0
  341. flowcellar-0.1.0/viewer/src/shell/paper.jsx +62 -0
  342. flowcellar-0.1.0/viewer/src/shell/parts.jsx +222 -0
  343. flowcellar-0.1.0/viewer/styles/app.css +805 -0
  344. flowcellar-0.1.0/viewer/styles/components.css +351 -0
  345. flowcellar-0.1.0/viewer/styles/tokens.css +993 -0
  346. flowcellar-0.1.0/viewer/verify/align.mjs +107 -0
  347. flowcellar-0.1.0/viewer/verify/analysis.mjs +157 -0
  348. flowcellar-0.1.0/viewer/verify/browser.mjs +62 -0
  349. flowcellar-0.1.0/viewer/verify/check.mjs +572 -0
  350. flowcellar-0.1.0/viewer/verify/close2.mjs +233 -0
  351. flowcellar-0.1.0/viewer/verify/firefox_pdf.mjs +78 -0
  352. flowcellar-0.1.0/viewer/verify/fixture.mjs +69 -0
  353. flowcellar-0.1.0/viewer/verify/libprep.mjs +83 -0
  354. flowcellar-0.1.0/viewer/verify/print.mjs +262 -0
  355. flowcellar-0.1.0/viewer/verify/query_vectors.mjs +33 -0
  356. flowcellar-0.1.0/viewer/verify/smoke.mjs +25 -0
  357. flowcellar-0.1.0/viewer/verify/units.mjs +120 -0
@@ -0,0 +1,22 @@
1
+ .venv/
2
+ node_modules/
3
+ __pycache__/
4
+ *.pyc
5
+ dist/
6
+ build/
7
+ *.egg-info/
8
+ .pytest_cache/
9
+ .ruff_cache/
10
+
11
+ # private working folders: never in the repository
12
+ local/
13
+ # the built viewer is made by the build, not kept in git
14
+ src/flowcellar/viewer_dist/
15
+ pw-browsers/
16
+ .cache/
17
+ viewer/src/gen/
18
+
19
+ # design documents and the prototype quote real run, project and sample names:
20
+ # keep them out of git until they have been scrubbed
21
+ design/
22
+ prototype/
@@ -0,0 +1,201 @@
1
+ # Changelog
2
+
3
+ Versions of the package, the bundle schema and the metric catalogue are counted separately; each entry
4
+ names all three.
5
+
6
+ ## 0.1.0 (November 2026)
7
+
8
+ The first public release. Bundle schema 0.1.1, metric catalogue 0.1.1, library layout 1.
9
+ Licence: GNU General Public License, version 3 or any later version (`GPL-3.0-or-later`).
10
+
11
+ ### What it does
12
+
13
+ - **Run health** from the folder MinKNOW writes, for the file layouts of MinKNOW 5 and 6: quick detail from
14
+ the small files in seconds, full detail from one pass over the sequencing summary and the pore-scan
15
+ table. Assay detection, runs in progress, interrupted runs, folders with raw data only. A flow cell that
16
+ is loaded a second time is recognised by its loadings and restarts and judged as a re-used flow cell.
17
+ - **Verdicts** in two parts, Run health and Read data, each with stored sentences that say what was
18
+ measured and against which limit. Output is compared with the lab's own history as of the day a run
19
+ started; a verdict is not changed by runs that come later.
20
+ - **Read data**, counted exactly and never sampled: one pass over Dorado and aligned BAMs (in parallel
21
+ where a BAM has an index), pychopper statistics, salmon, oarfish and kallisto output, basecaller sample
22
+ sheets. Files are attached to runs by the identifiers inside them first and by configured patterns
23
+ second. One source of record per run, sample and question; two candidates are never added together.
24
+ Sections: basecalled output, length, quality, length against quality, alignment, cDNA structure, read
25
+ fate.
26
+ - **Library**: `scan` over any number of roots creates and updates it, remembers the roots, names
27
+ projects from the folder structure and treats a project or a run found under two roots as one. Every
28
+ pass result is cached, so a second scan opens no data file. A root that is offline is skipped and
29
+ nothing under it changes. One scan at a time per library.
30
+ - **Viewer**: Home, Runs, Projects, a project, a run, a comparison of runs and the history of a flow
31
+ cell. The same viewer as one offline report per run, as a static hub opened from a file, and over
32
+ `flowcellar serve`. No page makes a request to anywhere.
33
+ - **Commands**: `scan`, `run`, `hub`, `serve`, `init`, `discover`, `ls`, `show`, `rm`,
34
+ `recompute --status-only`, `doctor`, `validate`, `schema`.
35
+ - **Packaging**: one pure-Python wheel and one source distribution, both with the built viewer and the
36
+ catalogue inside; Python 3.11 to 3.15; run-time dependencies numpy, pyarrow and click, with pysam in the
37
+ extra `bam` and jsonschema in the extra `validate`.
38
+
39
+ - **Every page uses the whole width of the window**, with the same two edges on every screen, and a pointer
40
+ over a chart changes the text of its read-out and nothing else.
41
+ - **Alignment**, from the same single pass over each BAM: a summary of read alignment as a ring with its
42
+ table (mapped and unmapped reads, secondary and supplementary records, reads with a supplementary
43
+ alignment); the breakdown of aligned bases (match, mismatch, insertion, deletion, soft and hard clip);
44
+ strand balance; depth along the reference with chromosome boundaries and the mean of each chromosome; reads
45
+ and bases per chromosome with the mitochondrial share; aligned length beside read length; the basecaller's
46
+ quality against the quality measured from the alignment; soft-clipped share per read; accuracy by read
47
+ length; read length against aligned length, identity against aligned length, read quality against identity.
48
+ - **Reads over run time**: output from the basecalled reads (reads and bases, passed and all), read length,
49
+ read quality, aligned length, identity and the measured speed through the pore, as a median with the
50
+ middle half of the reads, on the time axis of the run.
51
+ - **Transcripts**: for alignments to a transcriptome, coverage along the transcript from 5′ to 3′ by
52
+ transcript length, transcripts and genes found against reads sequenced, reads per transcript; poly(A) tail
53
+ length per sample from the `pt` tag, with the share of reads that have an estimate.
54
+ - **Pychopper**: a section of its own with every category of the statistics file, per sample and added up:
55
+ classification, strand, rescue, primer hits, primer arrangements, length and quality failures, UMIs, and
56
+ the tuning curve with the cut-off that was chosen.
57
+ - **RNA composition** from annotated read tables (role `polya.read_table`, read in one streamed pass): reads
58
+ and poly(A) tail length by transcript type, genes detected, the share of the most abundant genes.
59
+ - **Samples**: reads and bases per sample as charts, with the reads no sample was given to.
60
+ - **Single-cell and spatial analyses**: output folders of wf-single-cell and Space Ranger (Visium, Visium HD)
61
+ are recognised by their files, read, linked to the flow cell runs their reads came from and judged on their
62
+ own. New command `flowcellar analysis`; an Analyses tab and a page per analysis with a spatial map, read
63
+ fate, saturation, distributions per spot, bin or cell, and the two pipelines side by side; `ls --analyses`,
64
+ `show an_…`. The extra `sc` adds h5py for Space Ranger's HDF5 files.
65
+ - **Scan**: after an upgrade that changes what a pass counts, the files an earlier version had read are read
66
+ again first (newest runs first), then files never read; no file twice in one scan. `scan --read
67
+ bam|tables|analyses` chooses which kind of large file a scan reads.
68
+ - **Index**: column `t2_full_length` (full-length share of a cDNA run), shown in the peek panel of Runs and in
69
+ Compare; member `analyses`.
70
+ - **Wide windows**: the opening charts of Alignment lie four side by side; the spatial map of an analysis shows
71
+ a second picture of the same slide beside the first (another colouring, the tissue image where there is one),
72
+ and the two share the cursor.
73
+ - **`flowcellar run`**: the genome and the transcriptome alignment of one sample are taken for one sample
74
+ whatever their file names end in (`_genome`, `_gnome`, `_transcriptome`, `_txome`, …).
75
+ - Fixed: a roll-up over cells that hold curves no longer fails on the third cell; merged count tables keep
76
+ the name of their weight and the count that was folded into "other"; a share that is not zero is no longer
77
+ written "0.0 %"; a file read by an earlier version of a pass no longer counts as read for ever; a folder
78
+ into which the reports of several runs were copied is no longer taken for a run folder.
79
+
80
+ - **Save as PDF.** The page of a run, of a single-cell or spatial analysis, a comparison of runs and the
81
+ history of a flow cell have a control "Save as PDF", in the hub and in the one-file reports. It opens the
82
+ print dialog of the browser with a layout made for paper (A4 or Letter, upright): the first sheet says what
83
+ the sheets are, when the numbers were computed and by which version, then the verdict with both parts, the
84
+ key numbers and the selection that is shown; every section follows in the order of the page, without
85
+ navigation, controls and links, in the light theme whatever the screen shows. No chart, row of key numbers
86
+ or table row is cut where a sheet ends, no heading stands alone at the foot of one, and a table that is
87
+ wider than the sheet (the differences of eight compared runs) is scaled down until it fits. A PDF holds the
88
+ page as it is shown (open groups are in it, closed ones are counted as left out); a run page also offers
89
+ "PDF with every chart". The browser's own Print command gives the same sheets. Nothing is rendered outside
90
+ the browser and no dependency was added.
91
+ - **One analysis of merged reads, said as that.** A pychopper table or an annotated read table of a sample
92
+ that was sequenced on two flow cells is described as what it is: one analysis of reads that were merged
93
+ before the tool ran, shown on the page of each flow cell. A single-cell or spatial analysis made from several
94
+ flow cells says the same in its header, under its verdict and on the run page. The notes a bundle stores and
95
+ the sources of read fate use the same words.
96
+ - **A project as one PDF.** The page of a project has "Save as PDF" too. On paper it is a report of the project:
97
+ its numbers, every run of it oldest first with its verdict, run time, output, reads, pores, occupancy and read
98
+ N50, the reason of each run that did not pass, and the single-cell and spatial analyses made from its runs. The
99
+ folders the project lies in are left out of the PDF.
100
+ - A change of theme now reaches the colours of charts and legends that are already drawn (they kept the
101
+ colours of the theme the page was opened in).
102
+ - The browser checks run in Chromium as well (`FLOWCELLAR_BROWSER_ENGINE=chromium`); `viewer/verify/print.mjs`
103
+ checks the PDFs of both browsers.
104
+ - **An example to try it on.** `python -m flowcellar.testing.demo DIR` writes an invented laboratory (15 runs of 13
105
+ flow cells in four projects, with BAM files, pychopper statistics, annotated read tables, quantification
106
+ metadata and the analysis folders of a Visium and a Visium HD slide) and the `flowcellar.toml` of a library for
107
+ it. The README and its pictures are made from it; `tools/make_readme_pictures.py` makes the pictures again.
108
+ - **Limits of read data checks can be set per kind of run**, like those of run health:
109
+ `[profiles.<assay group>.rules.<check id>]` with `warn`, `fail` or `enabled = false`.
110
+ `flowcellar --config FILE run RUN_FOLDER -o DIR` judges a run without a library with the limits of that file.
111
+ - An analysis folder is no longer left out because a folder *above* the scanned folder is named `work` (data
112
+ under `/work/...`): scratch folders are told by the names below the scanned folder only.
113
+ - "Typical here is 727 Mb to 1.1 Gb": the lower end of a range keeps its unit when the two ends differ in unit.
114
+ - On PyPI the long description is the README with every path written as an address (`hatch_build.py`).
115
+
116
+ ### Known limits
117
+
118
+ What is measured
119
+
120
+ - The alignment, transcript, pychopper and RNA composition charts are shown, not judged: no check and no limit
121
+ uses their numbers yet.
122
+ - Charts over run time are binned on the clock (ten minutes for output, one hour for the medians), because a
123
+ pass over a file does not know when the run started. A step can begin up to that long before a whole step
124
+ of the run timeline; every point is drawn at its true time and the page says so. A rate per hour of the first
125
+ and the last step is worked out over the part of the step the run covers.
126
+ - A pychopper statistics table or an annotated read table that covers a sample on two flow cells cannot be
127
+ split: its counts are shown in full on both runs, and each page says so.
128
+ - A pychopper table that lacks a category stores zero for the numbers read from it; the section names them.
129
+ - Depth along the reference counts positions under a match, mismatch or deletion of primary alignments;
130
+ introns are not covered, secondary and supplementary records are left out.
131
+ - The curve of transcripts found against reads sequenced is the exact expectation from the read count of each
132
+ transcript, not a replay of the run in time. Reads per transcript are kept only while samples times
133
+ reference sequences stay under 64 million.
134
+ - Whether a BAM is aligned to a genome or to a transcriptome is told from its header; an unusual reference
135
+ can be misjudged (the evidence is stored with the section).
136
+ - The measured speed reads a little low on reads that were trimmed after basecalling: the duration covers the
137
+ whole read.
138
+ - For a choice of several samples, medians are read from stored histograms and can be one bin off; for all
139
+ samples and for one sample they are exact. Gene numbers exist per sample only.
140
+ - In an annotated read table a read that pychopper cut into pieces counts once per piece.
141
+ - From 13 samples on, two-dimensional charts, depth and curves over time are kept once for the run, not per
142
+ sample.
143
+ - Analyses: a link to a run that rests on a path or a sample name says so and is of low or medium confidence;
144
+ for wf-single-cell 3.x the molecules of the gene matrix and of the per-read table differ, so the saturation
145
+ tile and the saturation curve end a few points apart (the page says so); limits are provisional and not
146
+ tuned on any history.
147
+
148
+ - The estimated read N50 and median (before basecalling) are exact: the pass over the sequencing summary counts
149
+ reads per number of events. A result cached by a build that kept no such count is read off a histogram with
150
+ 40 bins per factor of ten instead (by rank inside a bin: typically within a fraction of a per cent of the
151
+ exact value, at worst the width of one bin, about 6 %), and the run page says so ("approximate");
152
+ `flowcellar scan --force --tier 1` counts such runs again.
153
+ - Read N50, median read length and median read quality of the read data, and the speed median, are read off
154
+ histograms by rank inside a bin (read lengths: 40 bins per factor of ten; speed: 5 bases per second). They
155
+ are close to the exact value (at worst one bin away), not exact.
156
+ - `scan` does not pick up the BAM files MinKNOW writes inside a run folder when it basecalls during the
157
+ run. `flowcellar run` on that folder does.
158
+ - The time box stops new passes from starting. A pass that is running when the box ends is finished, so a
159
+ scan can run a few minutes longer than its box.
160
+ - Home counts the read-data files that wait per run, the last line of `scan` counts them per file; the two
161
+ numbers can differ.
162
+
163
+ What is shown
164
+
165
+ - Of the 238 metrics in the catalogue, 107 have a label (and all 70 derived numbers, and all 57 metrics of
166
+ the single-cell and spatial catalogue); the others are shown under a name made from their id.
167
+ - The viewer is checked in Firefox and in Chromium (Playwright builds on Linux): not in Safari, not in Chrome
168
+ or Edge on Windows or macOS, not with a screen reader.
169
+ - A PDF comes from the print dialog of the browser: there is no `flowcellar` command that writes one (a
170
+ headless Chrome can print a report file from the command line). Home, Runs and Projects have no layout for
171
+ paper. Firefox writes charts into a PDF as pictures (three pixels to one, so they stay sharp); Chromium
172
+ writes them as drawings. Sheet numbers are the browser's.
173
+ - A report file names the licence of the viewer inside it and where its source is, and not the full licence
174
+ texts (FlowCellar's and Preact's); the package holds them, in `LICENSE` and `THIRD_PARTY_NOTICES.md`.
175
+
176
+ Where it runs
177
+
178
+ - Tested on Linux only. macOS is untried; on Windows pysam cannot be installed, so read data is not
179
+ available there, and the rest is untried.
180
+ - The two GitHub workflows have been checked step by step on a developer's machine but have never run on
181
+ GitHub.
182
+ - Used as a Python library, the read-data pass cannot start its worker processes from a program that is
183
+ given on standard input. The command line is not affected.
184
+ - With a temporary folder (`TMPDIR`) whose path is longer than about 75 characters, a pass that runs in
185
+ worker processes fails with "AF_UNIX path too long" (seen on the pass that counts the reads: Python keeps
186
+ the socket of its worker server in that folder). The scan names each run it could not read and ends with
187
+ exit code 5; with a shorter `TMPDIR` it runs.
188
+
189
+ ### Not built yet
190
+
191
+ Adaptive sampling; duplex; modified bases; what is particular to direct RNA beyond run health and poly(A)
192
+ tails; barcode balance; limits, hub columns and search keys for the numbers of those charts; analyses in
193
+ the search and in Compare; notes and tags on runs; saved views; editing limits in the viewer; a per-sample page; a project report file; a forecast for a run in
194
+ progress; export to tables and to MultiQC; import of bundles; computing parts of a run elsewhere and
195
+ merging them; migration between schema versions; a conda package.
196
+
197
+ ### Schema
198
+
199
+ Bundle schema 0.1.1. What changed against the draft 0.1.0 is listed in the schema file itself
200
+ (`flowcellar schema`, member `x-changes`). Readers accept any 0.1.x; no earlier version was released, so
201
+ there is nothing to migrate.