Changes between Version 4 and Version 5 of DevNotes/Obsolete/CodeRefactoring

Timestamp:

Jun 15, 2014 8:25:37 PM (10 years ago)

Author:

butler

Comment:

—

DevNotes/Obsolete/CodeRefactoring

@@ -5 +5 @@
 
  - Improve the maintainability of the code.
- - Cleanly separate the computation and the UI components to allow remote submission.
+ - Cleanly separate the computation and the UI components to allow
+  - easily replacing the UI if/when new technologies become available or when the current one becomes obsolete/unsupported
+  - remote submission (necessary to eventually allow use of clusters or HPC backends).
 
 The following approach is thought to be the most practical given the level of effort involved and the resources available.
 
 
-=== Medium-Term Goals ===
- - We will follow a progressive refactoring approach rather than a complete re-write.
- - We will keep the UI in wx for this first phase.
- - We will proceed by identifying use-cases that are known to involve code that need refactoring.
-   For each of those use-cases, we will identify the API needed to perform the calculations by script.
- - We will go through our use-cases and refactor the computation code to follow the new API.
-   We will also refactor the UI to use the newly refactored code.
- - We will release a version of !SasView once this work is completed.
+=== Suggested Approach (Medium-Term Goals) ===
+ - Follow a progressive refactoring approach rather than a complete re-write.
+ - Keep the UI in wx for this first phase.
+ - Proceed by identifying use-cases that are known to involve code that need refactoring.
+   For each of those use-cases, identify the API needed to perform the calculations by script.
+ - Go through our use-cases and refactor the computation code to follow the new API.
+   Refactor the UI to use the newly refactored code.
+ - Release a new version of !SasView once this work is completed.
 
 === Long-Term Goals ===
- - Building on the work described above, we will consider moving to !PyQt and/or building a web application version of !SasView.
+ - Building on the work described above, we will then consider moving to !PyQt and/or building a web application version of !SasView.
  - The following version of !SasView should be able to submit remote jobs to compute resources to be determined. Those will likely be located at labs, but could alternatively use services like Amazon AWS.