biotsr 1.0.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 (236) hide show
  1. biotsr-1.0.0/CHANGELOG.md +104 -0
  2. biotsr-1.0.0/CITATION.cff +34 -0
  3. biotsr-1.0.0/LICENSE +202 -0
  4. biotsr-1.0.0/MANIFEST.in +20 -0
  5. biotsr-1.0.0/NOTICE +130 -0
  6. biotsr-1.0.0/PKG-INFO +323 -0
  7. biotsr-1.0.0/README.md +284 -0
  8. biotsr-1.0.0/pyproject.toml +107 -0
  9. biotsr-1.0.0/setup.cfg +4 -0
  10. biotsr-1.0.0/src/biotsr/__init__.py +159 -0
  11. biotsr-1.0.0/src/biotsr/__main__.py +16 -0
  12. biotsr-1.0.0/src/biotsr/analysis/__init__.py +146 -0
  13. biotsr-1.0.0/src/biotsr/analysis/clustering.py +737 -0
  14. biotsr-1.0.0/src/biotsr/analysis/common_keys.py +357 -0
  15. biotsr-1.0.0/src/biotsr/analysis/features.py +215 -0
  16. biotsr-1.0.0/src/biotsr/analysis/render.py +239 -0
  17. biotsr-1.0.0/src/biotsr/analysis/samples.py +604 -0
  18. biotsr-1.0.0/src/biotsr/analysis/similarity.py +525 -0
  19. biotsr-1.0.0/src/biotsr/analysis/visualization.py +252 -0
  20. biotsr-1.0.0/src/biotsr/api.py +1950 -0
  21. biotsr-1.0.0/src/biotsr/batch.py +197 -0
  22. biotsr-1.0.0/src/biotsr/binning/__init__.py +20 -0
  23. biotsr-1.0.0/src/biotsr/binning/base.py +105 -0
  24. biotsr-1.0.0/src/biotsr/binning/distance.py +65 -0
  25. biotsr-1.0.0/src/biotsr/binning/theta.py +34 -0
  26. biotsr-1.0.0/src/biotsr/candidates/__init__.py +5 -0
  27. biotsr-1.0.0/src/biotsr/candidates/exhaustive.py +39 -0
  28. biotsr-1.0.0/src/biotsr/cli/__init__.py +42 -0
  29. biotsr-1.0.0/src/biotsr/cli/__main__.py +10 -0
  30. biotsr-1.0.0/src/biotsr/cli/batch.py +1777 -0
  31. biotsr-1.0.0/src/biotsr/cli/commands.py +985 -0
  32. biotsr-1.0.0/src/biotsr/cli/console.py +61 -0
  33. biotsr-1.0.0/src/biotsr/cli/errors.py +74 -0
  34. biotsr-1.0.0/src/biotsr/cli/main.py +214 -0
  35. biotsr-1.0.0/src/biotsr/cli/manifest.py +573 -0
  36. biotsr-1.0.0/src/biotsr/cli/output.py +964 -0
  37. biotsr-1.0.0/src/biotsr/cli/parallel.py +187 -0
  38. biotsr-1.0.0/src/biotsr/cli/parser.py +684 -0
  39. biotsr-1.0.0/src/biotsr/cli/sheet.py +667 -0
  40. biotsr-1.0.0/src/biotsr/cli/spec.py +571 -0
  41. biotsr-1.0.0/src/biotsr/cross/__init__.py +57 -0
  42. biotsr-1.0.0/src/biotsr/cross/candidates.py +138 -0
  43. biotsr-1.0.0/src/biotsr/cross/pools.py +602 -0
  44. biotsr-1.0.0/src/biotsr/cross/runner.py +216 -0
  45. biotsr-1.0.0/src/biotsr/cross/sides.py +288 -0
  46. biotsr-1.0.0/src/biotsr/domain/__init__.py +62 -0
  47. biotsr-1.0.0/src/biotsr/domain/candidate.py +59 -0
  48. biotsr-1.0.0/src/biotsr/domain/errors.py +96 -0
  49. biotsr-1.0.0/src/biotsr/domain/identity.py +206 -0
  50. biotsr-1.0.0/src/biotsr/domain/interpretation.py +213 -0
  51. biotsr-1.0.0/src/biotsr/domain/keyspace.py +380 -0
  52. biotsr-1.0.0/src/biotsr/domain/point.py +135 -0
  53. biotsr-1.0.0/src/biotsr/domain/result.py +501 -0
  54. biotsr-1.0.0/src/biotsr/domain/selection_record.py +249 -0
  55. biotsr-1.0.0/src/biotsr/encoding/__init__.py +5 -0
  56. biotsr-1.0.0/src/biotsr/encoding/key.py +110 -0
  57. biotsr-1.0.0/src/biotsr/geometry/__init__.py +34 -0
  58. biotsr-1.0.0/src/biotsr/geometry/conventions.py +173 -0
  59. biotsr-1.0.0/src/biotsr/geometry/ordering.py +221 -0
  60. biotsr-1.0.0/src/biotsr/geometry/triangle.py +182 -0
  61. biotsr-1.0.0/src/biotsr/io/__init__.py +25 -0
  62. biotsr-1.0.0/src/biotsr/io/input_columns.py +247 -0
  63. biotsr-1.0.0/src/biotsr/io/naming.py +263 -0
  64. biotsr-1.0.0/src/biotsr/io/native.py +408 -0
  65. biotsr-1.0.0/src/biotsr/io/native_read.py +514 -0
  66. biotsr-1.0.0/src/biotsr/labels/__init__.py +37 -0
  67. biotsr-1.0.0/src/biotsr/labels/elements.py +212 -0
  68. biotsr-1.0.0/src/biotsr/labels/resources/element_labels_v1.csv +111 -0
  69. biotsr-1.0.0/src/biotsr/labels/schemes.py +354 -0
  70. biotsr-1.0.0/src/biotsr/methods/__init__.py +13 -0
  71. biotsr-1.0.0/src/biotsr/methods/arguments.py +163 -0
  72. biotsr-1.0.0/src/biotsr/methods/builtin/__init__.py +12 -0
  73. biotsr-1.0.0/src/biotsr/methods/builtin/amino_acid_atomic.py +180 -0
  74. biotsr-1.0.0/src/biotsr/methods/builtin/carbohydrate.py +125 -0
  75. biotsr-1.0.0/src/biotsr/methods/builtin/cross.py +371 -0
  76. biotsr-1.0.0/src/biotsr/methods/builtin/drug.py +95 -0
  77. biotsr-1.0.0/src/biotsr/methods/builtin/nucleotide.py +140 -0
  78. biotsr-1.0.0/src/biotsr/methods/builtin/protein.py +78 -0
  79. biotsr-1.0.0/src/biotsr/methods/engine.py +307 -0
  80. biotsr-1.0.0/src/biotsr/methods/registry.py +85 -0
  81. biotsr-1.0.0/src/biotsr/modifiers/__init__.py +31 -0
  82. biotsr-1.0.0/src/biotsr/modifiers/aa_grouping.py +83 -0
  83. biotsr-1.0.0/src/biotsr/modifiers/base.py +89 -0
  84. biotsr-1.0.0/src/biotsr/modifiers/mirror.py +87 -0
  85. biotsr-1.0.0/src/biotsr/modifiers/size_filter.py +102 -0
  86. biotsr-1.0.0/src/biotsr/profiles/__init__.py +13 -0
  87. biotsr-1.0.0/src/biotsr/profiles/atomic.py +286 -0
  88. biotsr-1.0.0/src/biotsr/profiles/cross.py +118 -0
  89. biotsr-1.0.0/src/biotsr/profiles/standard.py +294 -0
  90. biotsr-1.0.0/src/biotsr/retrieval.py +1204 -0
  91. biotsr-1.0.0/src/biotsr/selection/__init__.py +55 -0
  92. biotsr-1.0.0/src/biotsr/selection/atomic.py +1028 -0
  93. biotsr-1.0.0/src/biotsr/selection/base.py +193 -0
  94. biotsr-1.0.0/src/biotsr/selection/completeness.py +283 -0
  95. biotsr-1.0.0/src/biotsr/selection/integrity.py +210 -0
  96. biotsr-1.0.0/src/biotsr/selection/protein.py +606 -0
  97. biotsr-1.0.0/src/biotsr/selection/truncation.py +93 -0
  98. biotsr-1.0.0/src/biotsr/sse/__init__.py +104 -0
  99. biotsr-1.0.0/src/biotsr/sse/assignment.py +364 -0
  100. biotsr-1.0.0/src/biotsr/sse/categories.py +203 -0
  101. biotsr-1.0.0/src/biotsr/sse/states.py +170 -0
  102. biotsr-1.0.0/src/biotsr/sse/stratification.py +228 -0
  103. biotsr-1.0.0/src/biotsr/structure/__init__.py +5 -0
  104. biotsr-1.0.0/src/biotsr/structure/backends/__init__.py +5 -0
  105. biotsr-1.0.0/src/biotsr/structure/backends/pdb_legacy.py +389 -0
  106. biotsr-1.0.0/src/biotsr/structure/model.py +211 -0
  107. biotsr-1.0.0/src/biotsr.egg-info/PKG-INFO +323 -0
  108. biotsr-1.0.0/src/biotsr.egg-info/SOURCES.txt +234 -0
  109. biotsr-1.0.0/src/biotsr.egg-info/dependency_links.txt +1 -0
  110. biotsr-1.0.0/src/biotsr.egg-info/entry_points.txt +2 -0
  111. biotsr-1.0.0/src/biotsr.egg-info/requires.txt +10 -0
  112. biotsr-1.0.0/src/biotsr.egg-info/top_level.txt +1 -0
  113. biotsr-1.0.0/tests/__init__.py +0 -0
  114. biotsr-1.0.0/tests/characterization/__init__.py +0 -0
  115. biotsr-1.0.0/tests/characterization/test_1ubq_historical_difference.py +160 -0
  116. biotsr-1.0.0/tests/conftest.py +156 -0
  117. biotsr-1.0.0/tests/data/legacy_outputs/before_adr101_hetatm_modified_residues/README.md +38 -0
  118. biotsr-1.0.0/tests/data/legacy_outputs/before_adr101_hetatm_modified_residues/SYNPHOS_A_specific.keys +458 -0
  119. biotsr-1.0.0/tests/data/legacy_outputs/before_adr101_hetatm_modified_residues/SYNPHOS_A_specific.meta.json +206 -0
  120. biotsr-1.0.0/tests/data/legacy_outputs/before_adr101_hetatm_modified_residues/SYNPHOS_A_specific.run.json +89 -0
  121. biotsr-1.0.0/tests/data/legacy_outputs/before_adr107_calpha_radix20/README.md +37 -0
  122. biotsr-1.0.0/tests/data/legacy_outputs/before_adr107_calpha_radix20/SYNPHOS_A_protein.keys +118 -0
  123. biotsr-1.0.0/tests/data/legacy_outputs/before_adr107_calpha_radix20/SYNPHOS_A_protein.meta.json +135 -0
  124. biotsr-1.0.0/tests/data/legacy_outputs/before_adr107_calpha_radix20/SYNPHOS_A_protein.run.json +101 -0
  125. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/1BNA_A_1-3_chain.keys +2463 -0
  126. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/1BNA_A_1-3_chain.meta.json +132 -0
  127. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/1BNA_A_1-3_chain.run.json +90 -0
  128. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/README.md +46 -0
  129. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/SYNPHOS_A_LIG101.keys +47 -0
  130. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/SYNPHOS_A_LIG101.meta.json +124 -0
  131. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/SYNPHOS_A_LIG101.run.json +97 -0
  132. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/SYNPHOS_A_protein.keys +360 -0
  133. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/SYNPHOS_A_protein.meta.json +132 -0
  134. biotsr-1.0.0/tests/data/legacy_outputs/before_adr113_adr114/SYNPHOS_A_protein.run.json +88 -0
  135. biotsr-1.0.0/tests/data/manifests/README.md +18 -0
  136. biotsr-1.0.0/tests/data/manifests/dataset_sheet.csv +6 -0
  137. biotsr-1.0.0/tests/data/manifests/wide_sheet.csv +9 -0
  138. biotsr-1.0.0/tests/data/reference/README.md +68 -0
  139. biotsr-1.0.0/tests/data/reference/atomic_element_labels.json +2312 -0
  140. biotsr-1.0.0/tests/data/reference/calpha_base30.json +2595 -0
  141. biotsr-1.0.0/tests/data/reference/historical/1UBQ_A_TSR-Package_TSR_keys.txt.gz +0 -0
  142. biotsr-1.0.0/tests/data/reference/standard_baseline.json +4879 -0
  143. biotsr-1.0.0/tests/data/structures/1BNA.pdb +944 -0
  144. biotsr-1.0.0/tests/data/structures/1BRS.pdb +5765 -0
  145. biotsr-1.0.0/tests/data/structures/1KX5.pdb +17996 -0
  146. biotsr-1.0.0/tests/data/structures/1TUP.pdb +6549 -0
  147. biotsr-1.0.0/tests/data/structures/1UBQ.pdb +970 -0
  148. biotsr-1.0.0/tests/data/structures/2AC0.pdb +8944 -0
  149. biotsr-1.0.0/tests/data/structures/3EJ1.pdb +9596 -0
  150. biotsr-1.0.0/tests/data/structures/3PTB.pdb +2264 -0
  151. biotsr-1.0.0/tests/data/structures/5WT9.pdb +9366 -0
  152. biotsr-1.0.0/tests/data/structures/6G9M.pdb +6742 -0
  153. biotsr-1.0.0/tests/data/structures/7LF9.pdb +7425 -0
  154. biotsr-1.0.0/tests/data/structures/manifest.json +167 -0
  155. biotsr-1.0.0/tests/data/synthetic/README.md +22 -0
  156. biotsr-1.0.0/tests/data/synthetic/SYNPHOS.pdb +181 -0
  157. biotsr-1.0.0/tests/data/synthetic/make_synthetic.py +102 -0
  158. biotsr-1.0.0/tests/integration/__init__.py +0 -0
  159. biotsr-1.0.0/tests/integration/test_analysis_comparison_rule.py +292 -0
  160. biotsr-1.0.0/tests/integration/test_analysis_cross_method.py +251 -0
  161. biotsr-1.0.0/tests/integration/test_api_guide.py +580 -0
  162. biotsr-1.0.0/tests/integration/test_atomic_end_to_end.py +396 -0
  163. biotsr-1.0.0/tests/integration/test_batch_engine.py +887 -0
  164. biotsr-1.0.0/tests/integration/test_batch_interruption.py +441 -0
  165. biotsr-1.0.0/tests/integration/test_cli_equivalence.py +393 -0
  166. biotsr-1.0.0/tests/integration/test_cli_retrieval_regressions.py +210 -0
  167. biotsr-1.0.0/tests/integration/test_cli_workflows.py +506 -0
  168. biotsr-1.0.0/tests/integration/test_comparison_altloc_instance_rules.py +414 -0
  169. biotsr-1.0.0/tests/integration/test_concurrent_invocations.py +255 -0
  170. biotsr-1.0.0/tests/integration/test_cross_families.py +837 -0
  171. biotsr-1.0.0/tests/integration/test_dataset_sheet_rows.py +246 -0
  172. biotsr-1.0.0/tests/integration/test_download_cancellation.py +360 -0
  173. biotsr-1.0.0/tests/integration/test_end_to_end.py +303 -0
  174. biotsr-1.0.0/tests/integration/test_input_rules.py +594 -0
  175. biotsr-1.0.0/tests/integration/test_ligand_carbohydrate_nucleotide_families.py +546 -0
  176. biotsr-1.0.0/tests/integration/test_modified_residue_calpha.py +434 -0
  177. biotsr-1.0.0/tests/integration/test_modified_residue_identifier_row_rules.py +529 -0
  178. biotsr-1.0.0/tests/integration/test_modifier_composition.py +343 -0
  179. biotsr-1.0.0/tests/integration/test_nucleotide_chain_available_atoms.py +260 -0
  180. biotsr-1.0.0/tests/integration/test_output_containment.py +190 -0
  181. biotsr-1.0.0/tests/integration/test_previous_outputs_element_labels.py +201 -0
  182. biotsr-1.0.0/tests/integration/test_processing_identity.py +442 -0
  183. biotsr-1.0.0/tests/integration/test_round_trip_families.py +311 -0
  184. biotsr-1.0.0/tests/integration/test_selection_provenance_regressions.py +163 -0
  185. biotsr-1.0.0/tests/integration/test_selection_rules.py +350 -0
  186. biotsr-1.0.0/tests/integration/test_sse_composition.py +354 -0
  187. biotsr-1.0.0/tests/integration/test_standard_references.py +344 -0
  188. biotsr-1.0.0/tests/integration/test_tutorials.py +229 -0
  189. biotsr-1.0.0/tests/integration/test_wide_sheet.py +432 -0
  190. biotsr-1.0.0/tests/support/__init__.py +0 -0
  191. biotsr-1.0.0/tests/support/stub_server.py +126 -0
  192. biotsr-1.0.0/tests/unit/__init__.py +0 -0
  193. biotsr-1.0.0/tests/unit/test_analysis_architecture.py +201 -0
  194. biotsr-1.0.0/tests/unit/test_analysis_clustering.py +273 -0
  195. biotsr-1.0.0/tests/unit/test_analysis_common_keys.py +361 -0
  196. biotsr-1.0.0/tests/unit/test_analysis_features.py +277 -0
  197. biotsr-1.0.0/tests/unit/test_analysis_math.py +294 -0
  198. biotsr-1.0.0/tests/unit/test_analysis_render.py +261 -0
  199. biotsr-1.0.0/tests/unit/test_analysis_similarity.py +217 -0
  200. biotsr-1.0.0/tests/unit/test_atomic.py +569 -0
  201. biotsr-1.0.0/tests/unit/test_binning.py +177 -0
  202. biotsr-1.0.0/tests/unit/test_candidates_and_hygiene.py +441 -0
  203. biotsr-1.0.0/tests/unit/test_cli_architecture.py +270 -0
  204. biotsr-1.0.0/tests/unit/test_cli_manifest.py +294 -0
  205. biotsr-1.0.0/tests/unit/test_cli_output.py +286 -0
  206. biotsr-1.0.0/tests/unit/test_cli_parsing.py +408 -0
  207. biotsr-1.0.0/tests/unit/test_cli_sheet.py +120 -0
  208. biotsr-1.0.0/tests/unit/test_cross_candidates.py +175 -0
  209. biotsr-1.0.0/tests/unit/test_cross_contact_rules.py +860 -0
  210. biotsr-1.0.0/tests/unit/test_cross_keyspace.py +236 -0
  211. biotsr-1.0.0/tests/unit/test_cross_ordering.py +199 -0
  212. biotsr-1.0.0/tests/unit/test_cross_pools.py +353 -0
  213. biotsr-1.0.0/tests/unit/test_cross_serialization.py +76 -0
  214. biotsr-1.0.0/tests/unit/test_distance_top_class_and_theta_bounds.py +175 -0
  215. biotsr-1.0.0/tests/unit/test_docs_links.py +119 -0
  216. biotsr-1.0.0/tests/unit/test_domain.py +225 -0
  217. biotsr-1.0.0/tests/unit/test_download_settings.py +102 -0
  218. biotsr-1.0.0/tests/unit/test_element_labels.py +359 -0
  219. biotsr-1.0.0/tests/unit/test_encoding.py +269 -0
  220. biotsr-1.0.0/tests/unit/test_geometry.py +416 -0
  221. biotsr-1.0.0/tests/unit/test_keyspace.py +230 -0
  222. biotsr-1.0.0/tests/unit/test_label_space_and_selection.py +411 -0
  223. biotsr-1.0.0/tests/unit/test_manifest_robustness.py +112 -0
  224. biotsr-1.0.0/tests/unit/test_modifiers.py +362 -0
  225. biotsr-1.0.0/tests/unit/test_native_round_trip.py +927 -0
  226. biotsr-1.0.0/tests/unit/test_ordering.py +269 -0
  227. biotsr-1.0.0/tests/unit/test_packaged_science_and_parser_semantics.py +292 -0
  228. biotsr-1.0.0/tests/unit/test_platform_identities.py +114 -0
  229. biotsr-1.0.0/tests/unit/test_release_readiness.py +857 -0
  230. biotsr-1.0.0/tests/unit/test_retrieval.py +340 -0
  231. biotsr-1.0.0/tests/unit/test_serialization.py +170 -0
  232. biotsr-1.0.0/tests/unit/test_sse_architecture.py +229 -0
  233. biotsr-1.0.0/tests/unit/test_sse_assignment.py +308 -0
  234. biotsr-1.0.0/tests/unit/test_sse_categories.py +247 -0
  235. biotsr-1.0.0/tests/unit/test_sse_serialization_and_analysis.py +391 -0
  236. biotsr-1.0.0/tests/unit/test_structure_and_selection.py +360 -0
@@ -0,0 +1,104 @@
1
+ # Changelog
2
+
3
+ All notable user-visible changes to BioTSR. Versions follow
4
+ [PEP 440](https://peps.python.org/pep-0440/); the release process is in
5
+ [docs/RELEASING.md](https://github.com/TSRMethod/BioTSR/blob/main/docs/RELEASING.md).
6
+
7
+ ## [1.0.0]
8
+
9
+ The first release of BioTSR, the unified software implementation of the
10
+ Triangular Spatial Relationship (TSR) methodology: one Python package, one
11
+ command line and one shared scientific core — the TSR Engine — in place of a
12
+ family of independent historical TSR programs. Every method runs under one
13
+ standard profile, the accepted TSR science as set by the TSR Research Group,
14
+ and writes one self-describing output format.
15
+
16
+ ### Platforms
17
+
18
+ - **CPython 3.9, 3.10, 3.11, 3.12 and 3.13, on Linux and macOS.** The full
19
+ default test suite runs on every one of them on Linux (x86-64) and on macOS
20
+ (arm64); the slow reference cases over large structures run on macOS arm64.
21
+ Keys, frequencies and fingerprints are identical on both systems.
22
+ - **Windows is not supported**: it is neither tested nor validated.
23
+ - Input is PDB format; mmCIF is not read.
24
+
25
+ ### Installation
26
+
27
+ - **From GitHub:** `pip install "biotsr @ git+https://github.com/TSRMethod/BioTSR@v1.0.0"`,
28
+ or the wheel and source distribution attached to the
29
+ [1.0.0 release](https://github.com/TSRMethod/BioTSR/releases/tag/v1.0.0); from a
30
+ clone, `pip install .`.
31
+ - **From PyPI:** `pip install biotsr`, available when
32
+ <https://pypi.org/project/biotsr/> lists version 1.0.0.
33
+ - One runtime dependency, joblib, runs batch rows in parallel; the calculation
34
+ itself uses the standard library only. The optional `plot` extra
35
+ (matplotlib) draws the clustered heat map.
36
+
37
+ ### What 1.0.0 provides
38
+
39
+ - **Twenty methods in three families:** protein Cα; atomic — amino-acid,
40
+ ligand, carbohydrate, nucleotide/DNA/RNA, and residue or atom selections;
41
+ and five cross (two-sided) methods — drug–protein, carbohydrate–protein,
42
+ nucleotide–protein, protein–protein all-atom and protein–protein Cα. The
43
+ [capability matrix](https://github.com/TSRMethod/BioTSR/blob/main/docs/CAPABILITY_MATRIX.md)
44
+ says what each supports.
45
+ - **One TSR Engine** — geometry, canonical vertex ordering, angle and distance
46
+ binning, labelling and integer key encoding shared by every method — with
47
+ composable modifiers: amino-acid grouping and SSE-TSR (18 secondary-structure
48
+ categories) on the Cα methods, mirror signing and size filtering.
49
+ - **Labels.** Cα points are labelled by residue — the 20 regular amino acids
50
+ and eleven modified residues — at radix 30, collision-free; atoms are
51
+ labelled by their PDB element field at radix 112, from one packaged,
52
+ validated element table.
53
+ - **Strict, recorded input rules.** Atom names and elements are read from their
54
+ full PDB fields, nothing is guessed, and a selection with an unknown residue
55
+ (`UNK`), an atom without an element, an atom written twice or an unreadable
56
+ residue number is refused with the records named.
57
+ - **Two identities on every result** — a `KeySpace` fingerprint (what the keys
58
+ mean) and a `SamplingProfile` fingerprint (how the triangles were drawn).
59
+ Results whose keys are defined differently are refused, never combined;
60
+ results processed under other settings, and partial results, are compared
61
+ only when acknowledged (`--allow-mixed-processing`, `--allow-partial`).
62
+ - **Native output** — `PREFIX.keys`, `PREFIX.triplets`, `PREFIX.meta.json` and
63
+ a completion record `PREFIX.run.json` written last — read back by
64
+ `biotsr.load_result` with both fingerprints restored.
65
+ - **Datasets.** `biotsr batch` over manifests and wide dataset sheets, with
66
+ `--dry-run`, verified resuming (`--if-exists skip`), parallel rows
67
+ (`--jobs`), a per-request `batch_summary.csv`, and opt-in, verified download
68
+ of PDB entries (`biotsr fetch`, `--download-missing`).
69
+ - **Analysis** over results of any method family: feature matrices, common
70
+ keys, five similarity measures, the average-linkage tree, dendrogram and
71
+ ordered heat map, and flat clusters by an explicit rule.
72
+ - **Licensed under the Apache License 2.0.** Third-party material keeps its
73
+ own terms; its notices are in
74
+ [`NOTICE`](https://github.com/TSRMethod/BioTSR/blob/main/NOTICE).
75
+
76
+ ### Known limitations
77
+
78
+ The [known limitations](https://github.com/TSRMethod/BioTSR/blob/main/docs/KNOWN_LIMITATIONS.md)
79
+ state each one precisely. In short: only the standard science is computed —
80
+ the historical programs' outputs are not reproduced; only model 1 of a PDB
81
+ file is read, with alternate locations blank or `A`; a `TER` record without a
82
+ chain identifier ends no chain; atomic methods read three modified amino acids
83
+ written as `HETATM` (TPO, SEP, PTR) and name the others; triplet files are
84
+ compared byte for byte only on macOS arm64, where their reference geometry was
85
+ produced; and similarity and clustering are available from Python, not from
86
+ the command line.
87
+
88
+ ### Results from the pre-release builds
89
+
90
+ 1.0.0 reads and compares the results of the last pre-release build as its own.
91
+ It refuses — it does not silently combine — older results whose keys mean
92
+ something else: Cα results from builds that labelled residues at radix 20, and
93
+ atomic results from builds that labelled atoms by name, must be computed
94
+ again, and outputs in the earlier per-sample directory layout are not read.
95
+ What changed from one pre-release build to the next is recorded in
96
+ [docs/PRE_RELEASE_CHANGES.md](https://github.com/TSRMethod/BioTSR/blob/main/docs/PRE_RELEASE_CHANGES.md).
97
+
98
+ Besides its version and release metadata, 1.0.0 corrects one thing in the last
99
+ pre-release build: when a download run (`biotsr fetch`, `--download-missing`)
100
+ is interrupted, an identifier that was still queued is reported `not_started`,
101
+ as documented. The worker that the cancellation freed could take it up first,
102
+ and it was then reported `interrupted` although nothing was requested for it.
103
+
104
+ [1.0.0]: https://github.com/TSRMethod/BioTSR/releases/tag/v1.0.0
@@ -0,0 +1,34 @@
1
+ # Citation metadata for BioTSR (Citation File Format 1.2.0).
2
+ #
3
+ # The authors, in the order the maintainers set. No DOI is recorded because none
4
+ # has been registered; when the release is archived (docs/RELEASING.md,
5
+ # section 10), its DOI is added here and to the README.
6
+ cff-version: 1.2.0
7
+ message: "If you use BioTSR in your research, please cite it using the metadata from this file."
8
+ type: software
9
+ title: "BioTSR"
10
+ abstract: >-
11
+ BioTSR is the unified software implementation of the Triangular Spatial
12
+ Relationship (TSR) methodology. It computes TSR keys -- integers encoding the
13
+ shape and vertex labels of triangles drawn over a 3D structure -- for protein
14
+ C-alpha, atomic, ligand, carbohydrate, nucleotide and cross (two-sided) method
15
+ families on one shared scientific core, each under its standard profile.
16
+ authors:
17
+ - given-names: "Poorya"
18
+ family-names: "Khajouie"
19
+ - given-names: "Krishna"
20
+ family-names: "Rauniyar"
21
+ - given-names: "Vijay V."
22
+ family-names: "Raghavan"
23
+ - given-names: "Wu"
24
+ family-names: "Xu"
25
+ version: "1.0.0"
26
+ license: Apache-2.0
27
+ repository-code: "https://github.com/TSRMethod/BioTSR"
28
+ url: "https://tsrmethod.github.io/"
29
+ keywords:
30
+ - "Triangular Spatial Relationship"
31
+ - "TSR"
32
+ - "protein structure"
33
+ - "structural bioinformatics"
34
+ - "PDB"
biotsr-1.0.0/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,20 @@
1
+ # What the source distribution carries, stated explicitly rather than left to
2
+ # setuptools' defaults. The sdist is the package plus what is needed to build,
3
+ # test and cite it -- including tests/data/structures/, the small set of
4
+ # unmodified PDB entries the computational tests run on. The frozen reference
5
+ # outputs, the historical programs and the documentation stay in the repository
6
+ # (docs/RELEASING.md).
7
+ include README.md CHANGELOG.md CITATION.cff pyproject.toml
8
+ # LICENSE and NOTICE are added by setuptools itself (its default license-file
9
+ # patterns) to both the sdist and the wheel.
10
+ graft src/biotsr
11
+ graft tests
12
+ prune validation
13
+ prune legacy
14
+ prune docs
15
+ prune .github
16
+ global-exclude __pycache__ *.py[cod] .DS_Store ._*
17
+ # Spreadsheets and private dataset tables never ship, even if one is left in the
18
+ # working tree (release_artifacts.py also refuses any member that is not a
19
+ # tracked file).
20
+ global-exclude *.xls *.xlsx *.xlsm *.ods *.numbers sample_details*.csv column_means*
biotsr-1.0.0/NOTICE ADDED
@@ -0,0 +1,130 @@
1
+ BioTSR
2
+ Copyright 2026 TSR Research Group
3
+
4
+ BioTSR is the unified software implementation of the Triangular Spatial
5
+ Relationship (TSR) methodology. It is licensed under the Apache License,
6
+ Version 2.0 (see LICENSE).
7
+
8
+ BioTSR includes, or is derived from, the third-party material listed below.
9
+ That material is not relicensed: each item remains under its own terms, and
10
+ its required notices are reproduced here. Provenance is recorded in
11
+ docs/LICENSING.md in the source repository
12
+ (https://github.com/TSRMethod/BioTSR/blob/main/docs/LICENSING.md). File paths
13
+ below are source-tree paths; in an installed package drop the leading "src/".
14
+
15
+ ------------------------------------------------------------------------------
16
+ 1. TSR-Package -- MIT License
17
+
18
+ Used for: the theta and distance bin tables (src/biotsr/binning/theta.py,
19
+ src/biotsr/binning/distance.py) and the amino-acid label and group tables
20
+ (src/biotsr/labels/schemes.py), whose values come from TSR-Package; the
21
+ secondary-structure category rules (src/biotsr/sse/), reimplemented from
22
+ TSR-Package's SSE_TSR.py; and, in the source distribution, one column of
23
+ TSR-Package output used as test reference data
24
+ (tests/data/reference/historical/).
25
+
26
+ MIT License
27
+
28
+ Copyright (c) 2024 Poorya Khajouie
29
+
30
+ Permission is hereby granted, free of charge, to any person obtaining a copy
31
+ of this software and associated documentation files (the "Software"), to deal
32
+ in the Software without restriction, including without limitation the rights
33
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
34
+ copies of the Software, and to permit persons to whom the Software is
35
+ furnished to do so, subject to the following conditions:
36
+
37
+ The above copyright notice and this permission notice shall be included in all
38
+ copies or substantial portions of the Software.
39
+
40
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
41
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
42
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
43
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
44
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
45
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
46
+ SOFTWARE.
47
+
48
+ ------------------------------------------------------------------------------
49
+ 2. CarbohydratesTSR -- MIT License
50
+
51
+ Used for: src/biotsr/labels/resources/element_labels_v1.csv, the element
52
+ codes of the CarbohydratesTSR atom lexicon (each chemical element with the
53
+ code the lexicon gives it; chlorine's from its CL rows).
54
+
55
+ MIT License
56
+
57
+ Copyright (c) 2026 Krishna Rauniyar
58
+
59
+ Permission is hereby granted, free of charge, to any person obtaining a copy
60
+ of this software and associated documentation files (the "Software"), to deal
61
+ in the Software without restriction, including without limitation the rights
62
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
63
+ copies of the Software, and to permit persons to whom the Software is
64
+ furnished to do so, subject to the following conditions:
65
+
66
+ The above copyright notice and this permission notice shall be included in all
67
+ copies or substantial portions of the Software.
68
+
69
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
70
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
71
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
72
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
73
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
74
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
75
+ SOFTWARE.
76
+
77
+ ------------------------------------------------------------------------------
78
+ 3. SciPy -- BSD 3-Clause License
79
+
80
+ Used for: src/biotsr/analysis/clustering.py follows the algorithms of
81
+ SciPy's nn_chain, maxclust and dendrogram implementation; how far its
82
+ results agree with particular SciPy releases is stated in
83
+ docs/methods/ANALYSIS.md. No SciPy code is imported or bundled.
84
+
85
+ Copyright (c) 2001-2002 Enthought, Inc. 2003, SciPy Developers.
86
+
87
+ Redistribution and use in source and binary forms, with or without
88
+ modification, are permitted provided that the following conditions
89
+ are met:
90
+
91
+ 1. Redistributions of source code must retain the above copyright
92
+ notice, this list of conditions and the following disclaimer.
93
+
94
+ 2. Redistributions in binary form must reproduce the above
95
+ copyright notice, this list of conditions and the following
96
+ disclaimer in the documentation and/or other materials provided
97
+ with the distribution.
98
+
99
+ 3. Neither the name of the copyright holder nor the names of its
100
+ contributors may be used to endorse or promote products derived
101
+ from this software without specific prior written permission.
102
+
103
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
104
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
105
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
106
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
107
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
108
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
109
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
110
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
111
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
112
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
113
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
114
+
115
+ ------------------------------------------------------------------------------
116
+ 4. Historical TSR repositories by Krishna Rauniyar (attribution)
117
+
118
+ The atom-count tables (src/biotsr/selection/completeness.py) and residue
119
+ sets (src/biotsr/cross/sides.py) are transcribed from TSR_AMINOACID_PACKAGE,
120
+ TSR_NUCLEOTIDE_PACKAGE, Nucleotide-Protein and CarbohydratesTSR. The first
121
+ three repositories carry no licence text of their own (docs/LICENSING.md).
122
+
123
+ ------------------------------------------------------------------------------
124
+ 5. Historical lineage (acknowledgement)
125
+
126
+ TSR-Package shares code with hsp70_actin (Feng Chen), whose key-generation
127
+ library credits Venkata Sarika Kondra; BioTSR's bin and label tables reach
128
+ it through TSR-Package. BioTSR contains no hsp70_actin code. The lineage was
129
+ considered by the ownership and provenance review
130
+ (docs/LICENSING.md).