factorforge-cds 3.1.8__tar.gz → 3.1.9__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 (62) hide show
  1. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/PKG-INFO +2 -2
  2. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/README.md +1 -1
  3. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/pyproject.toml +1 -1
  4. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/__init__.py +1 -1
  5. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/analysis/metrics.py +26 -0
  6. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/__init__.py +1 -1
  7. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/__init__.py +1 -1
  8. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/optimizer.py +6 -2
  9. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/pipeline.py +38 -2
  10. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/rules/reverse_translator.py +2 -2
  11. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/rules/rule_engine.py +10 -3
  12. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/scoring.py +64 -23
  13. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge_cds.egg-info/PKG-INFO +2 -2
  14. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/LICENSE +0 -0
  15. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/setup.cfg +0 -0
  16. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/__main__.py +0 -0
  17. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/analysis/__init__.py +0 -0
  18. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/analysis/feasibility.py +0 -0
  19. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/cli/__init__.py +0 -0
  20. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/cli/legacy_cli.py +0 -0
  21. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/cli/main.py +0 -0
  22. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/core/interfaces/__init__.py +0 -0
  23. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/core/interfaces/exporter.py +0 -0
  24. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/core/interfaces/optimizer.py +0 -0
  25. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/core/interfaces/validator.py +0 -0
  26. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/data/nbenthamiana_codons.json +0 -0
  27. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/data/nbenthamiana_golden_set.json +0 -0
  28. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/data/ntabacum_codons.json +0 -0
  29. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/data/templates/high_expression.json +0 -0
  30. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/data/templates/standard_expression.json +0 -0
  31. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/data/wolffia_globosa_codons.json +0 -0
  32. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/database.py +0 -0
  33. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/codon_table_builder.py +0 -0
  34. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/construct_builder.py +0 -0
  35. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/exporter.py +0 -0
  36. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/rules/__init__.py +0 -0
  37. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/rules/domesticator.py +0 -0
  38. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/scoring_ml.py +0 -0
  39. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/utils.py +0 -0
  40. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/profile/validator.py +0 -0
  41. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/engines/registry.py +0 -0
  42. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/schemas/__init__.py +0 -0
  43. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/schemas/design_package.py +0 -0
  44. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/schemas/design_package.schema.json +0 -0
  45. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/utils/__init__.py +0 -0
  46. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/utils/construct_id.py +0 -0
  47. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/utils/exceptions.py +0 -0
  48. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/utils/restriction_sites.py +0 -0
  49. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/utils/sequence_validator.py +0 -0
  50. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/utils/validation.py +0 -0
  51. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/validation/__init__.py +0 -0
  52. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/validation/cli.py +0 -0
  53. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge/validation/package_generator.py +0 -0
  54. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge_cds.egg-info/SOURCES.txt +0 -0
  55. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge_cds.egg-info/dependency_links.txt +0 -0
  56. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge_cds.egg-info/entry_points.txt +0 -0
  57. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge_cds.egg-info/requires.txt +0 -0
  58. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/src/factorforge_cds.egg-info/top_level.txt +0 -0
  59. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/tests/test_database.py +0 -0
  60. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/tests/test_legacy_cli.py +0 -0
  61. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/tests/test_restriction_sites.py +0 -0
  62. {factorforge_cds-3.1.8 → factorforge_cds-3.1.9}/tests/test_sequence_validator.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: factorforge-cds
3
- Version: 3.1.8
3
+ Version: 3.1.9
4
4
  Summary: FactorForge - open-source constraint-based CDS design engine by Eijex.
5
5
  Author-email: Eijex <eijex.lab@gmail.com>
6
6
  License-Expression: AGPL-3.0-only
@@ -107,7 +107,7 @@ FactorForge predictions are **in-silico only** and have not been experimentally
107
107
  ## Citing
108
108
 
109
109
  ```
110
- FactorForge v3.1.8 (2026). Open-source constraint-based CDS design engine.
110
+ FactorForge v3.1.9 (2026). Open-source constraint-based CDS design engine.
111
111
  Eijex. https://github.com/eijex/factorforge-cds
112
112
  ```
113
113
 
@@ -76,7 +76,7 @@ FactorForge predictions are **in-silico only** and have not been experimentally
76
76
  ## Citing
77
77
 
78
78
  ```
79
- FactorForge v3.1.8 (2026). Open-source constraint-based CDS design engine.
79
+ FactorForge v3.1.9 (2026). Open-source constraint-based CDS design engine.
80
80
  Eijex. https://github.com/eijex/factorforge-cds
81
81
  ```
82
82
 
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "factorforge-cds"
7
- version = "3.1.8"
7
+ version = "3.1.9"
8
8
  description = "FactorForge - open-source constraint-based CDS design engine by Eijex."
9
9
  readme = "README.md"
10
10
  license = "AGPL-3.0-only"
@@ -4,7 +4,7 @@ FactorForge - Codon Optimization Platform
4
4
  profile: constraint-aware rule/profile engine
5
5
  """
6
6
 
7
- __version__ = "3.1.8"
7
+ __version__ = "3.1.9"
8
8
  __author__ = "Eijex"
9
9
 
10
10
  # Auto-register engines (safe when running from source tree)
@@ -277,6 +277,32 @@ def calculate_cai(sequence: str, codon_weights: dict[str, float]) -> float:
277
277
  return math.exp(log_sum / count) if count else 0.0
278
278
 
279
279
 
280
+ def calculate_dinucleotide_score(
281
+ sequence: str,
282
+ cpg_weight: float = 0.0,
283
+ tpa_weight: float = 1.0,
284
+ ) -> float:
285
+ """Score dinucleotide avoidance.
286
+
287
+ Plant default: CpG inactive (cpg_weight=0.0), only TpA is penalized.
288
+ Mammalian opt-in: set cpg_weight=1.0 and tpa_weight=1.0 to penalize both.
289
+ """
290
+ from factorforge.engines.profile.utils import calculate_dinucleotide_ratio
291
+
292
+ if len(sequence) < 6:
293
+ return 1.0
294
+
295
+ total_weight = cpg_weight + tpa_weight
296
+ if total_weight == 0:
297
+ return 1.0
298
+
299
+ cpg_ratio = calculate_dinucleotide_ratio(sequence, "CG")
300
+ tpa_ratio = calculate_dinucleotide_ratio(sequence, "TA")
301
+ cpg_score = max(0.0, 1.0 - cpg_ratio / 2.0)
302
+ tpa_score = max(0.0, 1.0 - tpa_ratio / 2.0)
303
+ return (cpg_weight * cpg_score + tpa_weight * tpa_score) / total_weight
304
+
305
+
280
306
  def codon_usage_profile(sequence: str) -> dict[str, dict[str, float | int | str]]:
281
307
  """Return codon counts and frequencies for a DNA sequence."""
282
308
  codons = _codons(sequence)
@@ -13,7 +13,7 @@ def register_builtin_engines() -> None:
13
13
  "profile",
14
14
  RuleBasedOptimizer,
15
15
  metadata={
16
- "version": "3.1.8",
16
+ "version": "3.1.9",
17
17
  "engine_type": "profile_rule_based",
18
18
  "role": "stable_profile_engine",
19
19
  "stable": True,
@@ -5,7 +5,7 @@ Production system (2026)
5
5
  Plant-specific rule-based optimization
6
6
  """
7
7
 
8
- __version__ = "3.1.8"
8
+ __version__ = "3.1.9"
9
9
 
10
10
  from .optimizer import RuleBasedOptimizer
11
11
  from .pipeline import OptimizationPipeline
@@ -9,7 +9,7 @@ from factorforge.core.interfaces import OptimizationResult, OptimizerEngine
9
9
  from .exporter import SequenceExporter
10
10
  from .rules.reverse_translator import OptimizationProfile, ReverseTranslator
11
11
  from .rules.rule_engine import RuleEngine
12
- from .scoring import calculate_composite_score
12
+ from .scoring import calculate_composite_score, compute_mfe_evidence
13
13
  from .validator import InputValidator
14
14
 
15
15
 
@@ -17,7 +17,7 @@ class RuleBasedOptimizer(OptimizerEngine):
17
17
  """Profile-based rule optimization engine."""
18
18
 
19
19
  name = "Profile-based"
20
- version = "3.1.8"
20
+ version = "3.1.9"
21
21
 
22
22
  def __init__(self) -> None:
23
23
  self.validator = InputValidator()
@@ -117,6 +117,10 @@ class RuleBasedOptimizer(OptimizerEngine):
117
117
  "score": candidates[0]["score"],
118
118
  "violations": sum(len(v) for v in scan_results.values()),
119
119
  }
120
+ # MFE provenance: expose whether MFE was actually computed so downstream
121
+ # artifacts (API response, Design Package) never report an uncomputed
122
+ # MFE as a misleading 0.0 (016 audit). Score value is unchanged.
123
+ metrics.update(compute_mfe_evidence(optimized_dna, profile=profile_value))
120
124
 
121
125
  return OptimizationResult(
122
126
  sequence=optimized_dna,
@@ -18,9 +18,14 @@ from factorforge.engines.profile.rules.reverse_translator import (
18
18
  ReverseTranslator,
19
19
  )
20
20
  from factorforge.engines.profile.rules.rule_engine import RuleEngine
21
- from factorforge.engines.profile.scoring import calculate_composite_score
21
+ from factorforge.engines.profile.scoring import (
22
+ calculate_composite_score,
23
+ compute_mfe_evidence,
24
+ )
22
25
  from factorforge.engines.profile.validator import InputValidator
26
+ from factorforge.analysis.metrics import translate_dna
23
27
  from factorforge.utils.construct_id import generate_construct_id
28
+ from factorforge.utils.sequence_validator import validate_cds_output
24
29
 
25
30
  logger = logging.getLogger(__name__)
26
31
 
@@ -48,7 +53,15 @@ class PipelineResult:
48
53
  "optimization_profile": self.metadata.get("profile", ""),
49
54
  "cai_score": round(metrics.get("cai", 0.0), 4),
50
55
  "gc_content_pct": round(metrics.get("gc", 0.0), 2),
51
- "mfe_kcal_mol": round(metrics.get("mfe", 0.0), 2),
56
+ # MFE provenance (016 audit): None when not computed (e.g. ViennaRNA
57
+ # unavailable) — never report an uncomputed MFE as a misleading 0.0.
58
+ "mfe_kcal_mol": (
59
+ round(metrics["mfe_kcal_mol"], 2)
60
+ if metrics.get("mfe_kcal_mol") is not None
61
+ else None
62
+ ),
63
+ "mfe_status": metrics.get("mfe_status", "not_computed"),
64
+ "mfe_used": metrics.get("mfe_used", False),
52
65
  "polya_signal_count": len(scan.get("polya", [])),
53
66
  "domestication_edits": len(dom.get("removed_sites", [])),
54
67
  "sequence_length_aa": len(self.sequence) // 3,
@@ -175,6 +188,7 @@ class OptimizationPipeline:
175
188
 
176
189
  if seq_type == "dna":
177
190
  optimized_dna = processed
191
+ expected_protein = translate_dna(processed).rstrip("*")
178
192
  cai = translator.calculate_cai(optimized_dna)
179
193
  gc = translator.calculate_gc_content(optimized_dna)
180
194
  score = calculate_composite_score(
@@ -182,6 +196,7 @@ class OptimizationPipeline:
182
196
  )
183
197
  candidate_metrics = {"cai": cai, "gc": gc, "score": score}
184
198
  else:
199
+ expected_protein = processed.rstrip("*")
185
200
  logger.debug(f"Generating candidates with profile: {opt_profile.value}")
186
201
  candidates = translator.generate_candidates(processed, profile=opt_profile, n=1)
187
202
  if not candidates:
@@ -251,7 +266,20 @@ class OptimizationPipeline:
251
266
 
252
267
  assembly_standard = kwargs.get("assembly_standard", "golden_gate")
253
268
  domestication = domesticator.domesticate(optimized_dna, standard=assembly_standard)
269
+ if not domestication.get("success", False):
270
+ unfixable = domestication.get("unfixable", [])
271
+ error = domestication.get("error")
272
+ detail = error or f"unfixable restriction sites: {unfixable}"
273
+ raise ValueError(f"Domestication failed for {assembly_standard}: {detail}")
274
+
254
275
  domesticated_sequence = domestication.get("domesticated_seq", optimized_dna)
276
+ final_validation = validate_cds_output(expected_protein, domesticated_sequence)
277
+ if not final_validation["passed"]:
278
+ raise ValueError(
279
+ "Final CDS validation failed: "
280
+ f"{final_validation['errors']} "
281
+ f"(aa_identity={final_validation['aa_identity']:.4f})"
282
+ )
255
283
 
256
284
  template_name = construct_template or self.construct_template
257
285
  if template_name:
@@ -269,6 +297,13 @@ class OptimizationPipeline:
269
297
  construct_record = None
270
298
  final_sequence = domesticated_sequence
271
299
 
300
+ # MFE provenance for the final output sequence (016 audit): record
301
+ # whether MFE was computed so export_features / Design Package never
302
+ # report an uncomputed MFE as 0.0.
303
+ candidate_metrics.update(
304
+ compute_mfe_evidence(domesticated_sequence, profile=effective_profile)
305
+ )
306
+
272
307
  metadata: dict[str, Any] = {
273
308
  "construct_id": generate_construct_id(),
274
309
  "profile": effective_profile,
@@ -278,6 +313,7 @@ class OptimizationPipeline:
278
313
  "validation": val_result,
279
314
  "scan_results": scan_results,
280
315
  "domestication": domestication,
316
+ "final_validation": final_validation,
281
317
  "metrics": candidate_metrics,
282
318
  "scan_mode": scan_mode,
283
319
  }
@@ -551,8 +551,8 @@ class ReverseTranslator:
551
551
  """Apply N-terminal codon ramp for co-translational folding.
552
552
 
553
553
  Replaces the first `ramp_codons` codons with lower-frequency synonymous
554
- codons (bottom 50% by frequency) to slow the ribosome at the N-terminus.
555
- Single-codon amino acids (Met, Trp) are left unchanged.
554
+ codons (bottom 25% by frequency; cutoff = 3*len//4) to slow the ribosome
555
+ at the N-terminus. Single-codon amino acids (Met, Trp) are left unchanged.
556
556
 
557
557
  TODO: ramp profile is currently not in VALID_PROFILES (not publicly accessible).
558
558
  Before re-enabling, revisit ramp_codons=50:
@@ -354,13 +354,20 @@ class RuleEngine:
354
354
  max_gc: float = 75,
355
355
  ) -> list[dict[str, Any]]:
356
356
  """
357
- Detect extreme GC regions
357
+ Detect extreme GC regions in a sliding local window.
358
+
359
+ This is a LOCAL synthesis/extreme-window guard (default 25-75% over a
360
+ 50 bp window), NOT the global GC target. Global GC is governed separately
361
+ by the scoring band (GC_OPT_MIN/MAX, ~55-65%) and the API/DP gc_min/gc_max
362
+ constraints. The wide 25-75% band intentionally flags only synthesis-hostile
363
+ local windows; narrowing it toward the global optimum would raise false
364
+ positives against the engine's own output distribution (analysis 004: 55-71%).
358
365
 
359
366
  Args:
360
367
  seq: DNA sequence
361
368
  window: Window size (bp)
362
- min_gc: Minimum GC% threshold
363
- max_gc: Maximum GC% threshold
369
+ min_gc: Minimum local GC% threshold (synthesis guard, not global target)
370
+ max_gc: Maximum local GC% threshold (synthesis guard, not global target)
364
371
 
365
372
  Returns:
366
373
  List of violations
@@ -34,6 +34,8 @@ class ScoringConfig:
34
34
  w_gc: float = 0.3
35
35
  w_mfe: float = 0.2
36
36
  w_dinuc: float = 0.0 # CpG/TpA dinucleotide penalty (opt-in, default off)
37
+ cpg_weight: float = 0.0 # plant default: CpG inactive
38
+ tpa_weight: float = 1.0 # plant default: TpA active
37
39
  w_syncodonlm: float = 0.0 # SynCodonLM quality score (opt-in, default off)
38
40
  gc_opt: float = GC_OPT_MID # no longer used by calculate_composite_score (superseded by
39
41
  # gc_min/gc_max band); retained for external API compatibility
@@ -187,31 +189,19 @@ def gc_band_score(
187
189
  return max(0.0, 1.0 - distance / decay_width)
188
190
 
189
191
 
190
- def calculate_dinucleotide_score(sequence: str) -> float:
191
- """Calculate a dinucleotide avoidance score (0-1, higher = fewer CpG/TpA).
192
-
193
- Combines CpG and TpA observed/expected ratios. A sequence with no CpG
194
- and no TpA scores 1.0; high density scores toward 0.0.
195
-
196
- Args:
197
- sequence: DNA sequence.
192
+ def calculate_dinucleotide_score(
193
+ sequence: str,
194
+ cpg_weight: float = 0.0,
195
+ tpa_weight: float = 1.0,
196
+ ) -> float:
197
+ """Score dinucleotide avoidance.
198
198
 
199
- Returns:
200
- Dinucleotide avoidance score (0-1).
199
+ Plant default: CpG inactive (cpg_weight=0.0), only TpA is penalized.
200
+ Mammalian opt-in: set cpg_weight=1.0 and tpa_weight=1.0 to penalize both.
201
201
  """
202
- from factorforge.engines.profile.utils import calculate_dinucleotide_ratio
202
+ from factorforge.analysis.metrics import calculate_dinucleotide_score as _score
203
203
 
204
- if len(sequence) < 6:
205
- return 1.0
206
-
207
- cpg_ratio = calculate_dinucleotide_ratio(sequence, "CG")
208
- tpa_ratio = calculate_dinucleotide_ratio(sequence, "TA")
209
-
210
- # Score: 1.0 when ratio=0, 0.0 when ratio>=2.0
211
- cpg_score = max(0.0, 1.0 - cpg_ratio / 2.0)
212
- tpa_score = max(0.0, 1.0 - tpa_ratio / 2.0)
213
-
214
- return (cpg_score + tpa_score) / 2.0
204
+ return _score(sequence, cpg_weight=cpg_weight, tpa_weight=tpa_weight)
215
205
 
216
206
 
217
207
  def calculate_composite_score(
@@ -279,7 +269,11 @@ def calculate_composite_score(
279
269
  dinuc_score = 0.5 # neutral default
280
270
  actual_w_dinuc = config.w_dinuc
281
271
  if actual_w_dinuc > 0 and sequence is not None:
282
- dinuc_score = calculate_dinucleotide_score(sequence)
272
+ dinuc_score = calculate_dinucleotide_score(
273
+ sequence,
274
+ cpg_weight=config.cpg_weight,
275
+ tpa_weight=config.tpa_weight,
276
+ )
283
277
  elif actual_w_dinuc > 0:
284
278
  actual_w_dinuc = 0.0 # Cannot compute without sequence
285
279
 
@@ -308,3 +302,50 @@ def calculate_composite_score(
308
302
  )
309
303
 
310
304
  return round(score, 3)
305
+
306
+
307
+ def compute_mfe_evidence(
308
+ sequence: str | None,
309
+ config: ScoringConfig | None = None,
310
+ profile: str | None = None,
311
+ ) -> dict[str, Any]:
312
+ """Return MFE provenance metadata for a scored sequence.
313
+
314
+ Mirrors the MFE branch of ``calculate_composite_score`` WITHOUT changing the
315
+ score. Its purpose is honesty: when MFE is not computed (e.g. ViennaRNA is
316
+ unavailable in the deployment, as on Vercel), callers must be able to tell
317
+ that ``mfe_kcal_mol`` is absent rather than a genuine 0.0.
318
+
319
+ Returns a dict with:
320
+ mfe_kcal_mol: float | None (None when not computed)
321
+ mfe_status: "computed" | "not_computed"
322
+ mfe_used: bool (whether MFE contributed to the score)
323
+ mfe_warning: str | None (reason when not used)
324
+ score_components: {cai_used, gc_used, mfe_used}
325
+ """
326
+ if config is None:
327
+ profile_name = (profile or "balanced").lower()
328
+ config = PROFILE_SCORING_CONFIGS.get(profile_name) or PROFILE_SCORING_CONFIGS["balanced"]
329
+
330
+ mfe_value: float | None = None
331
+ reason: str | None = None
332
+
333
+ if not config.use_mfe:
334
+ reason = "MFE scoring is disabled for this profile."
335
+ elif sequence is None:
336
+ reason = "MFE was not computed because no sequence was provided."
337
+ elif not _check_vienna_available():
338
+ reason = "MFE was not computed because ViennaRNA is unavailable in this environment."
339
+ else:
340
+ mfe_value = calculate_mfe(sequence)
341
+ if mfe_value is None:
342
+ reason = "MFE computation failed for this sequence."
343
+
344
+ mfe_used = mfe_value is not None
345
+ return {
346
+ "mfe_kcal_mol": round(mfe_value, 2) if mfe_used else None,
347
+ "mfe_status": "computed" if mfe_used else "not_computed",
348
+ "mfe_used": mfe_used,
349
+ "mfe_warning": None if mfe_used else reason,
350
+ "score_components": {"cai_used": True, "gc_used": True, "mfe_used": mfe_used},
351
+ }
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: factorforge-cds
3
- Version: 3.1.8
3
+ Version: 3.1.9
4
4
  Summary: FactorForge - open-source constraint-based CDS design engine by Eijex.
5
5
  Author-email: Eijex <eijex.lab@gmail.com>
6
6
  License-Expression: AGPL-3.0-only
@@ -107,7 +107,7 @@ FactorForge predictions are **in-silico only** and have not been experimentally
107
107
  ## Citing
108
108
 
109
109
  ```
110
- FactorForge v3.1.8 (2026). Open-source constraint-based CDS design engine.
110
+ FactorForge v3.1.9 (2026). Open-source constraint-based CDS design engine.
111
111
  Eijex. https://github.com/eijex/factorforge-cds
112
112
  ```
113
113
 
File without changes