Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduction Plan Screen - Design #25

Merged
merged 16 commits into from
Apr 23, 2024
Merged

Reduction Plan Screen - Design #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
42251cf
updates in: oncat mvp, reduction plan screen added
mpatrou Apr 11, 2024
f9ef49a
reduction plan activities, high model added, presenter in progress
mpatrou Apr 12, 2024
8fa9548
updates in models, mvp, format, etc
mpatrou Apr 16, 2024
91c2553
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 16, 2024
87ce6de
info and links
mpatrou Apr 16, 2024
937b166
updates
mpatrou Apr 17, 2024
f91d638
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 17, 2024
eede4db
remove select option
mpatrou Apr 17, 2024
e994bef
unique identifier for reduction plan model, functionality updated, fi…
mpatrou Apr 18, 2024
cd64891
typo fixed
mpatrou Apr 18, 2024
6a8d67e
typos
mpatrou Apr 18, 2024
0bda8ea
error fixed
mpatrou Apr 18, 2024
e881f7b
errors fixed
mpatrou Apr 18, 2024
c9a60ba
links updates and details added
mpatrou Apr 19, 2024
61bf560
updates from cis meeting
mpatrou Apr 22, 2024
ee81d4e
minor updates
mpatrou Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/design/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Contents

instrument
reduction_plan
reduction_plan_mvp
oncat
oncat_general
oncat_mvp
9 changes: 6 additions & 3 deletions docs/source/design/instrument.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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{
Expand All @@ -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.
14 changes: 9 additions & 5 deletions docs/source/design/oncat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>`_ .
Expand All @@ -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{
<>
Expand All @@ -39,6 +42,7 @@ Related APIS:
+String ipts_number
+List~RunModel~ run_list
+get_run_list()
+calculate_run_plot()

}

Expand Down
2 changes: 1 addition & 1 deletion docs/source/design/oncat_general.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading