(r8) JmmcObsPortalArchictecture < Jmmc/Software

Tags: view all tags

---+ JMMC/ObsPortal: Software architecture
---++ Questions

Several points must be discussed in order to define an architecture.

Vollt library (CDS) provides a TAP reference implementation:
   * https://github.com/gmantele/vollt
   * see http://cdsportal.u-strasbg.fr/taptuto/index.html
---+++ Usages
   * What do we want to do?
      * Using Aspro2
         * To find past observations about selected targets (with the same interferometer, instrument, configuration, ...) directly from the GUI or using SAMP + web portal
         * To display these observations by plotting points under "Observability" and "UV coverage" tabs
      * Using a Web portal
         * May provide an advanced web interface to search / filter observation logs
         * Could provide SAMP interoperability (like CDS simbad / vizier) to ASPRO2 (custom messages + votable output)
---+++ Data
   * On which metadata to search and filter the observations?
      * target name
         * will not work !
      * target coordinates
         * Requires cone-search (like TAP)
      * ...
   * Which metadata to display for one observation?
      * To plot the observation under "Observability" tab
         * LST ranges or MJD ranges (converted by ASPRO2 at the given interferometer)
      * To plot the observation under "UV coverage" tab
         * UV point per baseline (radius, angle in ESO archive) + instrument wavelength range to draw the UV segments per baseline
      * To show inside a tooltip
         * Observation setup (interferometer, instrument, mode, identifiers ...)
   * Where to find the source metadata?
      * Extracted from headers provided by the ESO Archive but stored in a 'standard' DM to also handle CHARA observation logs in the future
      * See the page [[http://www.jmmc.fr/twiki/bin/view/Jmmc/Software/JmmcObsPortalDataAnalysis][JmmcObsPortalDataAnalysis]] for the keywords mapping
   * 
---+++ Protocols and links between software parts
   * Aspro2 &lt;--&gt; "ObsPortal System"
      * How to query the "ObsPortal System" from Aspro2?
         * How?
            * Directly
            * Via [[A2P2][A2P2 (NO)]]
         * Which protocol?
            * API REST on HTTP/HTTPS (maybe)
            * SAMP (maybe with web portal)
            * TAP (?)
         * Which parameters?
            * See the question "On which metadata to search and filter the observations?" (target coordinates first ie 1 object per query)
      * How to send the query results to Aspro2?
         * How?
            * Directly
            * Via A2P2 [[A2P2][ (NO)]]
            * By a generated intermediary file (OBXml / Asprox)
         * Which protocol?
            * API REST on HTTP/HTTPS
            * SAMP
            * TAP
         * Which data structure?
            * JSON (NO)
            * VOTable (1)
            * OBXml (2)
            * Asprox (NO)
            * ...
         * Which properties to return?
            * See the questions "Which metadata to display for one observation?"

   * OiDB &lt;--&gt; "ObsPortal System"

---++ Modeling method

The architecture will be designed using the method described on https://c4model.com and the online modeling tool [[https://www.draw.io][draw.io]]

---++ Current context around OiDB

<img alt="JMMC-ObsPortal-C1-current.png" height="802" src="%ATTACHURL%/JMMC-ObsPortal-C1-current.png" title="JMMC-ObsPortal-C1-current.png" width="1121" />

Source: [[%ATTACHURL%/JMMC-ObsPortal-C1-current.drawio][JMMC-ObsPortal-C1-current.drawio]]

---++ ObsPortal architecture
---+++ Level 1: System context

A *System Context* diagram provides a starting point, showing how the software system in scope fits into the world around it.

<img alt="JMMC-ObsPortal-C1.png" height="771" src="%ATTACHURL%/JMMC-ObsPortal-C1.png" title="JMMC-ObsPortal-C1.png" width="1121" />

Source: [[%ATTACHURL%/JMMC-ObsPortal-C1.drawio][JMMC-ObsPortal-C1.drawio]]
---++++ Comments

At this step, a first question is related to the integration and the future role of OiDB and A2P2...
---+++ Level 2: Container

A *Container* diagram zooms into the software system in scope, showing the high-level technical building blocks.
---++++ Proposition 1

<img alt="JMMC-ObsPortal-C2.png" height="811" src="%ATTACHURL%/JMMC-ObsPortal-C2.png" title="JMMC-ObsPortal-C2.png" width="1081" />

Source: [[%ATTACHURL%/JMMC-ObsPortal-C2.drawio][JMMC-ObsPortal-C2.drawio]]

The "Observation system" will be composed by:
   * a dedicated database
   * a backend application ("Core Application")
   * a frontend application ("Web Application"), if needed. Il may be part of "Core Application"...
The backend may be decomposed in:
   * an API application proxying requests from Aspro2 to the database
   * a "data feeder" application retrieving new metadata from sources (ESO, CHARA, ...) and inserting the selected properties into the database
---+++ Level 3: Component

A *Component* diagram zooms into an individual container, showing the components inside it.
---+++ Level 4: Code

A *code* (e.g. UML class) diagram can be used to zoom into an individual component, showing how that component is implemented.

-- %USERSIG{PhilippeBollard - 2019-11-26}%

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who
drawio	JMMC-ObsPortal-C1-current.drawio	r2 r1	manage	2.9 K	2019-11-27 - 13:49	PhilippeBollard
png	JMMC-ObsPortal-C1-current.png	r2 r1	manage	83.1 K	2019-11-27 - 13:50	PhilippeBollard
drawio	JMMC-ObsPortal-C1.drawio	r3 r2 r1	manage	2.6 K	2019-12-02 - 17:05	PhilippeBollard
png	JMMC-ObsPortal-C1.png	r3 r2 r1	manage	79.5 K	2019-12-02 - 17:06	PhilippeBollard
drawio	JMMC-ObsPortal-C2.drawio	r1	manage	2.9 K	2019-11-27 - 16:56	PhilippeBollard
png	JMMC-ObsPortal-C2.png	r1	manage	94.3 K	2019-11-27 - 16:56	PhilippeBollard

Topic revision: r8 - 2019-12-02 - PhilippeBollard