Reduction Plan Screen - Design (#25)

* updates in: oncat mvp, reduction plan screen added * reduction plan activities, high model added, presenter * updates in models, mvp, format, etc * unique identifier for reduction plan model, functionality updated, filepath exposed * links updates and details added * updates from cis meeting --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
neutrons · Apr 23, 2024 · d2ebb55 · d2ebb55
1 parent 82987cc
commit d2ebb55
Show file tree

Hide file tree

Showing 7 changed files with 922 additions and 113 deletions.
diff --git a/docs/source/design/index.rst b/docs/source/design/index.rst
@@ -17,6 +17,7 @@ Contents
 
    instrument
    reduction_plan
+   reduction_plan_mvp
    oncat
    oncat_general
    oncat_mvp
diff --git a/docs/source/design/instrument.rst b/docs/source/design/instrument.rst
@@ -1,15 +1,15 @@
 .. _instrument:
 
-Instrument Schema
+Instrument Model
 =======================
 
 The Instrument model is described in `Data Dictionary Instrument Configuration <https://ornlrse.clm.ibmcloud.com/rm/web#action=com.ibm.rdm.web.pages.showArtifactPage&artifactURI=https%3A%2F%2Fornlrse.clm.ibmcloud.com%2Frm%2Fresources%2FTX_gl6-gMwZEe6kustJDRk6kQ&componentURI=https%3A%2F%2Fornlrse.clm.ibmcloud.com%2Frm%2Frm-projects%2F_DADVIOHJEeyU5_2AJWnXOQ%2Fcomponents%2F_DEP4oOHJEeyU5_2AJWnXOQ&vvc.configuration=https%3A%2F%2Fornlrse.clm.ibmcloud.com%2Frm%2Fcm%2Fstream%2F_DEcs8OHJEeyU5_2AJWnXOQ>`_.
 
 .. mermaid::
 
  classDiagram
-    InstrumentModel "1" o--"3" InstrumentProjectionFieldModel: grouping_field,run_number_field, scale_field
-    InstrumentModel "1" o--"N<=3" InstrumentGoniometerAngleModel
+    InstrumentModel "1" *--"3" InstrumentProjectionFieldModel: grouping_field,run_number_field, scale_field
+    InstrumentModel "1" *--"N<=3" InstrumentGoniometerAngleModel
 
     class InstrumentModel{
         +String facility
@@ -19,6 +19,7 @@ The Instrument model is described in `Data Dictionary Instrument Configuration <
         +String raw_file_format
         +List~InstrumentGoniometerAngleModel~ goniometer_settings
         +List~InstrumentProjectionFieldModel~ run_schema
+        +create()
 
     }
     class InstrumentGoniometerAngleModel{
@@ -33,3 +34,5 @@ The Instrument model is described in `Data Dictionary Instrument Configuration <
         +String field_name
         +String oncat_meta_field
     }
+
+The Instrument is created from the InstrumentConfiguration Settings.
diff --git a/docs/source/design/oncat.rst b/docs/source/design/oncat.rst
@@ -1,6 +1,6 @@
 .. _pyoncat:
 
-PyOnCat Schema
+PyOnCat Model
 ===================
 
 The PyOnCat is described in `Data Dictionary OnCat <https://ornlrse.clm.ibmcloud.com/rm/web#action=com.ibm.rdm.web.pages.showArtifactPage&artifactURI=https%3A%2F%2Fornlrse.clm.ibmcloud.com%2Frm%2Fresources%2FTX_X6q9wNStEe6uLrx4w2K0Ew&vvc.configuration=https%3A%2F%2Fornlrse.clm.ibmcloud.com%2Frm%2Fcm%2Fstream%2F_DEcs8OHJEeyU5_2AJWnXOQ&componentURI=https%3A%2F%2Fornlrse.clm.ibmcloud.com%2Frm%2Frm-projects%2F_DADVIOHJEeyU5_2AJWnXOQ%2Fcomponents%2F_DEP4oOHJEeyU5_2AJWnXOQ>`_ .
@@ -19,17 +19,20 @@ Related APIS:
     PyOnCatModel "1" o--"N" ExperimentModel
     ExperimentModel "1" o--"N" RunModel
     PyOnCatModel "1" -->"1" InstrumentModel
-    RunModel "1" o--"N<=3" GoniometerAngleKeyValueModel
-    RunModel "1" o--"3" ProjectionFieldKeyValueModel
+    RunModel "1" *--"N<=3" GoniometerAngleKeyValueModel
+    RunModel "1" *--"3" ProjectionFieldKeyValueModel
 
     class PyOnCatModel{
         +InstrumentModel instrument
         -PyOnCat:ONCat oncat_agent
         +String data_source_filepath
-        +ExperimentModel selected_experiment
+        +Number selected_experiment_index
         +List~ExperimentModel~ experiment_list
         +get_experiments()
-
+        +add_agent()
+        +add_instrument()
+        +select_experiment()
+        +add_datasource_filepath()
     }
     class InstrumentModel{
         <>
@@ -39,6 +42,7 @@ Related APIS:
         +String ipts_number
         +List~RunModel~ run_list
         +get_run_list()
+        +calculate_run_plot()
 
     }
 

diff --git a/docs/source/design/oncat_general.rst b/docs/source/design/oncat_general.rst
@@ -20,7 +20,7 @@ Related APIS:
     PyOnCatModel "1" o--"N" ExperimentModel
     ExperimentModel "1" o--"N" RunModel
     PyOnCatModel "1" -->"1" InstrumentModel
-    RunModel "1" o--"N<=170" ProjectionFieldKeyValueModel
+    RunModel "1" *--"N<=170" ProjectionFieldKeyValueModel
 
     class PyOnCatModel{
         +InstrumentModel instrument