Push REC V1.0 to master

.github/workflows/build.yml

@@ -0,0 +1,50 @@
+# This file generated from a template file maintained in the ivoatex repository.
+# To create and install it into a project repository, do:
+#    make github-preview
+#    git commit
+#    git push
+#
+name: Check the IVOA document
+
+env:
+  doc_name: MANGO
+
+defaults:
+  run:
+    working-directory: doc
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout the repository
+      uses: actions/checkout@v1
+      with:
+        submodules: true
+
+    - name: Setup dependencies
+      run: |
+        sudo apt update
+        sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super
+
+    - name: Build the document
+      run: make ${{ env.doc_name }}.pdf
+
+    - name: Check the output
+      run: |
+        test -f ${{ env.doc_name }}.pdf
+        test -f ${{ env.doc_name }}.bbl
+
+    - name: Keep the PDF artefact 
+      uses: actions/upload-artifact@v4
+      with:
+        name: PDF Preview
+        path: doc/${{ env.doc_name }}.pdf
+

.github/workflows/preview.yml

@@ -1,8 +1,13 @@
+# This file generated from a template file maintained in the ivoatex repository.
+# To create and install it into a project repository, do:
+#    make github-preview
+#    git commit
+#    git push
+#
 name: Update PDF Preview
 
 defaults:
   run:
-    shell: bash
     working-directory: doc
 
 env:
@@ -11,45 +16,44 @@ env:
 on:
   push:
     branches:
-      - master
+      - final-review
+      - pr-1.0
 
 jobs:
   build:
-    
+
     runs-on: ubuntu-latest
-    
+
     steps:
-    
+
     - name: Checkout the repository
       uses: actions/checkout@v1
       with:
         submodules: true
-    
+
     - name: Setup dependencies
       run: |
         sudo apt update
-        sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc
+        sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super
         sudo snap install pdftk
-    
+
     - name: Build the document
-      run: |
-       make biblio ${{ env.doc_name }}-draft.pdf
-
+      run: make ${{ env.doc_name }}-draft.pdf
+
     - name: Check the output
       run: |
-        ls
         test -f ${{ env.doc_name }}-draft.pdf
         test -f ${{ env.doc_name }}.bbl
-    
+
     - name: Move the auto-pdf-preview tag
-      uses: weareyipyip/walking-tag-action@v1
+      uses: weareyipyip/walking-tag-action@v2
       with:
-        TAG_NAME: auto-pdf-preview
-        TAG_MESSAGE: |
+        tag-name: auto-pdf-preview
+        tag-message: |
           Last commit taken into account for the automatically updated PDF preview of this IVOA document.
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-    
+
     - name: Update the PDF preview
       uses: Xotl/cool-github-releases@v1
       with:

.github/workflows/preview.yml.org

@@ -0,0 +1,69 @@
+name: Update PDF Preview
+
+defaults:
+  run:
+    shell: bash
+    working-directory: doc
+
+env:
+  doc_name: MANGO
+
+on:
+  push:
+    branches:
+      - master
+      - wd-v1.0
+      - draft-0.1
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout the repository
+      uses: actions/checkout@v1
+      with:
+        submodules: true
+
+    - name: Setup dependencies
+      run: |
+        sudo apt update
+        sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super
+        sudo snap install pdftk
+
+    - name: Build the document
+      run: |
+        make forcetex
+        make ${{ env.doc_name }}-draft.pdf
+
+    - name: Check the output
+      run: |
+        test -f ${{ env.doc_name }}-draft.pdf
+        test -f ${{ env.doc_name }}.bbl
+
+    - name: Move the auto-pdf-preview tag
+      uses: weareyipyip/walking-tag-action@v2
+      with:
+        tag-name: auto-pdf-preview
+        tag-message: |
+          Last commit taken into account for the automatically updated PDF preview of this IVOA document.
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Update the PDF preview
+      uses: Xotl/cool-github-releases@v1
+      with:
+        mode: update
+        isPrerelease: true
+        tag_name: auto-pdf-preview
+        release_name: "Auto PDF Preview"
+        body_mrkdwn: |
+          This release aims to provide a PDF preview of the last commit applied on this repository.
+          It will be updated automatically after each merge of a PullRequest.
+          **DO NOT PUBLISH THIS PRE-RELEASE!**"
+          _Corresponding commit: ${{ github.sha }}_
+        assets: doc/${{ env.doc_name }}-draft.pdf
+        replace_assets: true
+        github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -33,10 +33,12 @@
 *.fdb_latexmk
 *.fls
 *.gz
+*.pyc
 draft-background.*
 # Maven 
 target/
-
+__pycache__
+__cache__
 # eclipse project file
 .settings/
 .classpath
@@ -50,3 +52,11 @@ target/
 release.properties
 pom.xml.releaseBackup
 pom.xml.tag
+*.pdf
+
+.pydevproject
+*.html
+
+trash/*
+exercise*
+test-date/*

README.md

@@ -1,12 +1,69 @@
 
 # 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.
+The MANGO data 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 deals with catalog entries, corresponding to astronomical sources or detections
+of those and represent them as a MANGO Object class.  
+- It attaches identifiers on the "MANGO object" class and associates to each one a flexible 
+set of properties (e.g. observed physical quantities).
+- It offers to link other information like detection status, quality annotation, preview images, etc.
+Properties may be expressed as several columns of a data table.
+MANGO object properties can import classes of the IVOA Measurements
+and Coordinates data models.
+- It reuses PhotDM
+- It proposes its own classes for the quantities that are not covered by the imported models.
+- The roles of properties are qualified by semantic tags to provide rich context. 
+
+# Document Building
+
+## Repository Folders
+
+- `doc`: contains the Tex files. Do not edit `model.tex` by hand, this file is generated by the document builder. 
+- `implementations`: contains annotated VOtable implementing most of the model features.
+                     Please read the [note](./impldementations/README.md) to see which model features are covered.
+- `model`: UML diagrams edited with Modelio and the XMI file.
+- `vo-dml`: all VODML related stuff. Do not edit `desc.mango.vo-dml.xml`, this file is generated by the document builder
+  - `desc`: contains the text descriptions of all model elements
+  - `section`: contains the head description for the section added by hand in the model table of content.
+- `utils`: contains the scripts used to build the document.
+- `mivot`: contains Mivot snippets covering Mango classes that can be reused to  build annotations.
+
+## 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 edition wiyth Modelio 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 this [note](./utils/README.md).
+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-validator`in 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
 

doc/.github/workflows/build.yml

@@ -0,0 +1,49 @@
+# This file generated from a template file maintained in the ivoatex repository.
+# To create and install it into a project repository, do:
+#    make github-preview
+#    git commit
+#    git push
+#
+name: Check the IVOA document
+
+env:
+  doc_name:
+
+defaults:
+  run:
+    working-directory: doc
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout the repository
+      uses: actions/checkout@v1
+      with:
+        submodules: true
+
+    - name: Setup dependencies
+      run: |
+        sudo apt update
+        sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super
+
+    - name: Build the document
+      run: make
+
+    - name: Check the output
+      run: |
+        test -f ${{ env.doc_name }}.pdf
+        test -f ${{ env.doc_name }}.bbl
+
+    - name: Keep the PDF artefact
+      uses: actions/upload-artifact@v1
+      with:
+        name: PDF Preview
+        path: ${{ env.doc_name }}.pdf