reillytilbury / coppafish

Python version of iss software
MIT License
4 stars 2 forks source link

Backwards Compatibility Tracker #369

Open paulshuker opened 2 weeks ago

paulshuker commented 2 weeks ago

We should have code that looks something like

class CompatibilityChecker:
  # Each coppafish labelled stage, in chronological order.
  _coppafish_stages = ("extract", "filter", "find spots", "register", "stitch", "call spots", "omp", "none")
  # For each coppafish version, a stage is given for the earliest stage that would require re-running as a result of the changes.
  _coppafish_compatibility = {
    "0.10.7": "none",
    "1.0.0": "extract",
    "1.1.0": "find_spots",
  }

which can tell us programmatically that for version 0.1.1 migrating from results from 1.0.0, the user must start from find spots or earlier. Then, we can make a messaging system of what must be deleted for results to be correctly carried over when moving from version x to version y.