Noise Monitor ApplicationNoise Monitor ApplicationProgramming Interface (NMAPI)Programming Interface (NMAPI)

Current status and plansCurrent status and plans

A.Colla, E.Cuoco, G.HemmingA.Colla, E.Cuoco, G.Hemming

24/01/1224/01/12

19/04/23 2

This presentationThis presentation

This presentation looks at the following areas:This presentation looks at the following areas:

• What is NMAPI?What is NMAPI?

• ArchitectureArchitecture

• Administrating NMAPIAdministrating NMAPI

• What standard users can do with NMAPIWhat standard users can do with NMAPI

• Benefits of the toolBenefits of the tool

• External application linkagesExternal application linkages

• Further developmentsFurther developments

19/04/23 3

What is NMAPI?What is NMAPI?

• NMAPI is a lightweight application, which allows different NMAPI is a lightweight application, which allows different data-processing scripts to interface to a common web-data-processing scripts to interface to a common web-based UI.based UI.

• Administrators can determine how their script is Administrators can determine how their script is accessed without requiring a knowledge of HTML - either accessed without requiring a knowledge of HTML - either language or standards.language or standards.

• Users query datasets via administrator-customised Users query datasets via administrator-customised forms, deciding in which format to produce results: forms, deciding in which format to produce results: currently HTML or text files.currently HTML or text files.

19/04/23 4

ArchitectureArchitecture

19/04/23 5

Architecture - 2Architecture - 2

• NMAPI currently sits on olserver31.NMAPI currently sits on olserver31.

• It sits and waits for requests, passed via HTTPS.It sits and waits for requests, passed via HTTPS.

• Upon request receipt, the information is passed to the Upon request receipt, the information is passed to the dedicated Noise Monitor dedicated Noise Monitor Steering ScriptSteering Script, which deals , which deals with retrieving requested results from data source.with retrieving requested results from data source.

19/04/23 6

Administering NMAPI - GeneralAdministering NMAPI - General

Administrators configure the scripts for which they are Administrators configure the scripts for which they are responsible, defining:responsible, defining:

• relevant file paths;relevant file paths;

• method of script execution (Python, etc.);method of script execution (Python, etc.);

• channels associated to script;channels associated to script;

• summaries and descriptions;summaries and descriptions;

• available output formats;available output formats;

• how arguments passed to a script are separated;how arguments passed to a script are separated;

• arguments to be passed to scripts.arguments to be passed to scripts.

Administrators can also activate an internal de-bugging Administrators can also activate an internal de-bugging functionality to assist in Steering Script configuration.functionality to assist in Steering Script configuration.

19/04/23 7

Administering NMAPI – The Admin InterfaceAdministering NMAPI – The Admin Interface

Administrators configure the scripts for which they are Administrators configure the scripts for which they are responsible, defining:responsible, defining:

19/04/23 8

Administering NMAPI – Defining argumentsAdministering NMAPI – Defining arguments

19/04/23 9

What can standard users do with NMAPI?What can standard users do with NMAPI?

NMAPI functionality enables standard users to:NMAPI functionality enables standard users to:

• view date and channel-specific NM summary data;view date and channel-specific NM summary data;

• produce bespoke, personalised results, using the admin-produce bespoke, personalised results, using the admin-customised script launch HTML form;customised script launch HTML form;

• pass directly from results produced on-the-fly by one NM pass directly from results produced on-the-fly by one NM to results produced on-the-fly by another;to results produced on-the-fly by another;

• save produced text format results.save produced text format results.

19/04/23 10

What can standard users do with NMAPI?What can standard users do with NMAPI?

The NM Summary interface, which enables users to view The NM Summary interface, which enables users to view date and channel-specific summaries via a JavaScript date and channel-specific summaries via a JavaScript calendar:calendar:

19/04/23 11

What can standard users do with NMAPI?What can standard users do with NMAPI?

The Steering Script launch interface, which is built by the The Steering Script launch interface, which is built by the Administrator via the NM Admin interface:Administrator via the NM Admin interface:

19/04/23 12

Example NMAPI standard user path - 1*Example NMAPI standard user path - 1*

• Using the Using the NoEMi Lines NoEMi Lines and and NoEMi PeakMapsNoEMi PeakMaps Noise Noise Monitors, for example: Monitors, for example:

• A user examines the A user examines the NoEMi LinesNoEMi Lines summary page, which summary page, which contains a list of all the lines archived in the contains a list of all the lines archived in the LinesDB.LinesDB.

* Taken from Amaldi poster: Colla, Cuoco, Hemming, ‘* Taken from Amaldi poster: Colla, Cuoco, Hemming, ‘Noise Monitor tools & their application to Virgo data’’

19/04/23 13

Example NMAPI standard user path - 2Example NMAPI standard user path - 2

• An inspection of the results shows a line of particular An inspection of the results shows a line of particular interest (for example the 18.6Hz which presumably seems interest (for example the 18.6Hz which presumably seems to be due to the motor of an air conditioning machine in to be due to the motor of an air conditioning machine in the Virgo Central building and which enters the data via the Virgo Central building and which enters the data via the seismic path).the seismic path).

19/04/23 14

Example NMAPI standard user path - 3Example NMAPI standard user path - 3

• A look at the plot related to the line confirms that the line A look at the plot related to the line confirms that the line is worth examining in further detail.is worth examining in further detail.

19/04/23 15

Example NMAPI standard user path - 4Example NMAPI standard user path - 4

• The user studies the history of the disturbances in the The user studies the history of the disturbances in the Dark Fringe and the coincident auxiliary channels versus Dark Fringe and the coincident auxiliary channels versus time, using the calendar tool available to the time, using the calendar tool available to the NoEMi NoEMi PeakMapsPeakMaps summary pages, in order to choose a day of summary pages, in order to choose a day of interest.interest.

• Via the NM script interface, the user launches the steering Via the NM script interface, the user launches the steering script, using the criteria detailed in the second step, script, using the criteria detailed in the second step, providing a detailed peak-map or line plot for a specific providing a detailed peak-map or line plot for a specific channel.channel.

19/04/23 16

Example NMAPI standard user path - 5Example NMAPI standard user path - 5

19/04/23 17

Example NMAPI standard user path - 6Example NMAPI standard user path - 6

• The user confirms the results by looking at the The user confirms the results by looking at the CoherenceCoherence tool:tool:

19/04/23 18

Example NMAPI standard user path - 7Example NMAPI standard user path - 7

• From here it is possible, using From here it is possible, using LinesDBLinesDB, to search for, or , to search for, or insert, related metadata, describing the line and providing insert, related metadata, describing the line and providing qualitative information regarding, for example, where and qualitative information regarding, for example, where and how the line has been measured.how the line has been measured.

19/04/23 19

Benefits of the toolBenefits of the tool• The majority of graphics – all non-summary plots - are The majority of graphics – all non-summary plots - are

produced on-the-fly by users and are, consequently, not produced on-the-fly by users and are, consequently, not saved to disk. This inevitably vastly reduces the amount of saved to disk. This inevitably vastly reduces the amount of disk space required for storage.disk space required for storage.

• By providing a standardised interface users only have to By providing a standardised interface users only have to learn how to use a single, straightforward tool, rather than learn how to use a single, straightforward tool, rather than different interfaces for different Noise Monitors.different interfaces for different Noise Monitors.

• NMAPI has been designed to be fully extensible, so that it NMAPI has been designed to be fully extensible, so that it can grow and take into account new suggestions and can grow and take into account new suggestions and developments in a manner that is fully transparent for developments in a manner that is fully transparent for already existing NM.already existing NM.

• NMAPI is a socket into which NM are plugged. However, in NMAPI is a socket into which NM are plugged. However, in itself it is so lightweight and flexible that it can also be itself it is so lightweight and flexible that it can also be plugged-in elsewhere, e.g. the Noise web pages.plugged-in elsewhere, e.g. the Noise web pages.

19/04/23 20

External application linkagesExternal application linkages

• Currently, NMAPI links to ChannelsDB, enabling users to view Currently, NMAPI links to ChannelsDB, enabling users to view information on the channel being used in results production.information on the channel being used in results production.

• Further linkages are planned with other applications, via the Further linkages are planned with other applications, via the forthcoming Connections Database (CDB):forthcoming Connections Database (CDB):

– Hardware Inventory and Integration database (HWII);Hardware Inventory and Integration database (HWII);

– Virgo Logbook.Virgo Logbook.

19/04/23 21

Further developments – LinesDB - 1Further developments – LinesDB - 1

• Given the flexibility of NMAPI, LinesDB, which was initially Given the flexibility of NMAPI, LinesDB, which was initially planned as a stand-alone application, is being integrated into planned as a stand-alone application, is being integrated into the NMAPI framework.the NMAPI framework.

• LinesDB draws information from the results produced by NoEMi LinesDB draws information from the results produced by NoEMi Lines, dividing the lines found by that application into ‘known’ Lines, dividing the lines found by that application into ‘known’ and ‘unknown’ lines. Users can categorise lines as ‘known’ via and ‘unknown’ lines. Users can categorise lines as ‘known’ via the NMAPI interface.the NMAPI interface.

• LinesDB enables line-related metadata to be entered by users LinesDB enables line-related metadata to be entered by users and stored in order to conserve a history of lines over time; and stored in order to conserve a history of lines over time; helping to avoid the loss of line-related information and serving helping to avoid the loss of line-related information and serving as a central point of reference.as a central point of reference.

19/04/23 22

Further developments – LinesDB - 2Further developments – LinesDB - 2

• Latest ‘unknown’ lines table – updated daily:Latest ‘unknown’ lines table – updated daily:

19/04/23 23

Further developments – LinesDB - 3Further developments – LinesDB - 3

• Latest ‘known’ lines table – updated by users:Latest ‘known’ lines table – updated by users:

19/04/23 24

The future – D-NMAPIThe future – D-NMAPI