Skip to content
/ MANGO Public
generated from ivoa-std/doc-template

Model for Annotating Generic Objects in VOTables

Notifications You must be signed in to change notification settings

ivoa-std/MANGO

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

At a glance

The MANGO model proposes a flexible way to expose data related to astronomical source objects in an interoperable way.

  • It takes into account the huge diversity of source data in terms of feature description, format and usage.
  • The MANGO model attaches an identifier on an astronomical source and associates to it all data related : observed physical quantities called parameters in this context, and other information like spectra, time series, preview image, for instance,for that source.
  • Parameters usually appear in the columns of a source catalogue. Additionnal dataproducts are bound to the source to contribute to the science analysis and enhance data understanding.
  • Parameters are modeled by the IVOA MCT DM reusing both native and extended classes. Parameters' roles are given by UCDs and semantic tags.
  • Associated data can be simple URLs, VO service endpoints or VO data model instances. Their roles are also qualified by semantic tags.

Document Building

Why such a Complex Workflow?

The process of creating the document is a bit complex due to the following facts:

  • The model is maintained with Modelio which does not support any version control.
  • It is designed in a way to make sure that the diagrams keep in sync with the UML.
  • As the text Modelio edition is quite painful, it has been decided to store the description of all model elements in individual files (vodml/desc).
  • The VODML (without description) is generated by an XSLT
  • The transformation of the VODML into Latex is done by another XSLT
  • The items of the generated Latex are ordered following the VODML elements order, this must be corrected to have a consistent table of content

This process is achieved by scripts located in utils. Please read utils/README.rst. If you want to contribute, please have a look at this workflow or ask the editor. This will prevent your work to be overridden by some script.

How to Contribute Anyway

  • Install mivot-validatorin your favorite virtual environment
  • Modify the description of some model elements (section 3-11 at the time of writing)
    • go into ./vo-dml/desc
    • edit the file you want to update
    • go into utils
    • run ./buildDoc.bash
  • Modify the plain text (section out of 3-11 at the time of writing)
    • go into `./doc
    • edit MANGO.tex or tap.tex, those files are never overridden.
    • go into utils
    • run ./buildDoc.bash
  • Modify the model itself
    • ask the editor with an issue

If you want to contribute, please have a look at this workflow or ask the editor.

PDF preview

The PDF preview can be seen here thanks to the ADQL team who has written a workflow generating it automatically.

Licence

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.