search

JMMC-OpenDev / OI-Imaging-JRA

Design and specification of an interface to image reconstruction and model fitting from optical interferometric data
4 stars 6 forks source link

SOFTWARE and VERSION #10

Closed FerreolS closed 2 years ago

FerreolS commented 2 years ago

We should add a software (or algorithm) and software version keywords in IMAGE-OI OUTPUT PARAM :

FerreolS commented 2 years ago

Up to now, there is no way to know which software was used to create an OI-Interface image. We could use an heuristic to infer it but I think, it should be in the standard somehow

jsy1001 commented 2 years ago

The ESO standard is:

PROCSOFT Indicates the reduction software system including its version number used to produce this data product.

FerreolS commented 2 years ago

Ok. PROCSOFT keyword may be already used by the reduction pipeline. As an example, PIONIER oifits files contains in the primary header : PROCSOFT= 'pndrs_v3.52' / Data reduction software and version Is setting the algorithm in PROCSOFT keyword in IMAGE-OI OUTPUT PARAM hdu is sufficiently clear?

jsy1001 commented 2 years ago

I think its clear from the context of being in a different hdu.

GillesDuvert commented 2 years ago

there is already VERSION ?

FerreolS commented 2 years ago

There in no eso keyword for version. The version number seems to be usually added to the software name in the PROCSOFT keyword

emmt commented 2 years ago

Now that I have the hands in MiRA, I am going to give a try to PROCSOFT as follows (https://github.com/emmt/MiRA/commit/c666226fe806537385ba2ca554f819a04250a7e1):

PROCSOFT= 'MiRA v2.3.2' / Data reduction software and version
jsy1001 commented 2 years ago

For bsmem see https://gitlab.com/jsy1001/bsmem/-/issues/9

jsy1001 commented 2 years ago

I've implemented PROCSOFT for bsmem.

buthanoid commented 2 years ago

I created an issue for OImaging https://github.com/JMMC-OpenDev/oimaging/issues/96

GillesDuvert commented 2 years ago

What would be the version of Wisard at any moment? At the moment it is 3.2.2 . This is not an internal Wisard number, it is a Github release number triggered by Laurent. It would be nice to have PROCSOFT set to the release number 'automatically'. Since the number is a string, I figure a GH script could insert the actual release number in the Wisard "code", as it is not compiled but just a procedure. Any other solution leads to a discrepancy between PROCSOFT and the only number availble around, the GH release number. Or am I confused?

FerreolS commented 2 years ago

Ok. That seems doable, it is probably just a few lines to add in the dockerfile : https://github.com/JMMC-OpenDev/oimaging-uws-server/blob/master/runtime/docker/oiservices/Dockerfile

jsy1001 commented 2 years ago

We should document this usage of PROCSOFT in the specification document.