Merge branch 'ivoa-std:master' into Rebin-Reproject-Params

.github/workflows/build.yml

@@ -0,0 +1,45 @@
+# 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: SODA
+
+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

.github/workflows/preview.yml

@@ -0,0 +1,66 @@
+# 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
+
+env:
+  doc_name: SODA
+
+on:
+  push:
+    branches:
+      - master
+
+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 ${{ 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: ${{ env.doc_name }}-draft.pdf
+        replace_assets: true
+        github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,13 @@
+*.blg
+*.toc
+*.out
+*.pdf
+*.aux
+*.bbl
+ivoatexmeta.tex
+*.log
+*.html
+*.zip
+*.fdb_latexmk
+*.fls
+gitmeta.tex

Makefile

@@ -30,3 +30,7 @@ VECTORFIGURES =
 AUX_FILES = 
 
 include ivoatex/Makefile
+
+## temporary:
+role_diagram.pdf:
+	echo "static REC-SODA-1.0 role_diagram.pdf"

README.md

@@ -1,5 +1,37 @@
-# doc-template
-document template
+[![PDF-Preview](https://img.shields.io/badge/Preview-PDF-blue)](../../releases/download/auto-pdf-preview/SODA-draft.pdf)
+
+
+# SODA (Server-side Operations for Data Access)
+
+SODA is a low-level data access
+capability or server side data processing that can act upon the data
+files, performing various kinds of operations: filtering/subsection,
+transformations, pixel operations, and applying functions to the data.
+
+## Status
+
+The last stable version is
+**[REC-1.0](https://www.ivoa.net/documents/SODA/20170517/index.html)**.
+
+
+## Want to contribute?
+
+1. [Raise a GitHub Issue](https://github.com/ivoa-std/SIA/issues/new) on this
+   repository
+
+2. Fork this repository _(eventually clone it on your machine if you want to)_
+
+3. Create a branch in your forked repository ; this branch should be named after the issue(s) to fix (for instance: `issue-7-add-license`)
+
+4. Commit suggested changes inside this branch
+
+5. Create a Pull Request on the official repository _(note: a `git push` is needed first, if you are working on a clone)_
+
+6. Wait for someone to review your Pull Request and accept it
+
+_This process has been described and demonstrated during the IVOA Interoperability Meeting of Oct. 2019 in Groningen ; see [slides](https://wiki.ivoa.net/internal/IVOA/InterOpOct2019GitHub/IVOA_Github.pdf))_
+
+## License
 
 <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
   <img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a>

SODA.tex

@@ -83,19 +83,19 @@ \subsection{The Role in the IVOA Architecture}
 
 Figure~\ref{fig:architecture} shows how SODA fits into the IVOA architecture.
 SODA services conform to the Data Access Layer Interface (DALI,
-\citet{std:DALI}) specification, 
+\citet{2013ivoa.spec.1129D}) specification, 
 including the Virtual Observatory Support Interfaces (VOSI,
-\citet{std:VOSI}) resources.
+\citet{2011ivoa.spec.0531G}) resources.
 
 Within the IVOA architecture, SODA services could be found and used in
 several ways. First, a SODA service could be found in the IVOA Registry
 and used directly. A description of a SODA service may be found along
 with specific dataset metadata at either the data discovery phase using
-Simple Image Access (SIA, \citet{std:SIAv2}) or Table Access Protocol
-(TAP, \citet{std:TAP}) and the ObsCore data model \citep{std:OBSCORE} or
-via a DataLink \citep{std:DataLink} service. The service descriptors and
-three-factor semantics rely on UCDs \citep{std:UCD} and the VO Unit
-specification \citep{std:VOUNIT}. Since the discovery of SODA services
+Simple Image Access (SIA, \citet{2015ivoa.spec.1223D}) or Table Access Protocol
+(TAP, \citet{2010ivoa.spec.0327D}) and the ObsCore data model \citep{2011ivoa.spec.1028T} or
+via a DataLink \citep{2015ivoa.spec.0617D} service. The service descriptors and
+three-factor semantics rely on UCDs \citep{2005ivoa.spec.1231D} and the VO Unit
+specification \citep{2014ivoa.spec.0523D}. Since the discovery of SODA services
 makes use of DataLink service descriptor(s) to provide parameter
 metadata, the VOSI-capabilities specified in
 Section~\ref{sec:capabilities} do not make use of a registry extension.
@@ -417,6 +417,19 @@ \subsection{Filtering Parameters}
 Filtering parameters are used to extract subsets of large
 datasets or data files. The extraction uses a best possible match to the requested subset. In case the parameter values excede the size of the archived dataset  the service operates a reduction of these values to the archived dataset size.
 
+\subsubsection{MOC}
+The MOC parameter defines a subset of space using the \xtype{moc} defined in DALI. The parameter syntax is defined as in the MOC specification \citep{MOC2}
+
+Examples :
+\begin{itemize}
+
+\item Extracting cells 1 and 2 at order 1 will read this way MOC = 1/1 2
+\item Extracting cells 1 at order 1 and cells 1 to 6 at order 2 will read MOC = 1/1 2/1-6
+
+\end{itemize}
+
+
+At the time of writing there is no possibility to extend this ascii syntax to TMOC or STMOC
 
 \subsubsection{POS}
 \label{sec:POS}
@@ -715,7 +728,7 @@ \subsection{Filtering parameters and ObsCore data model}
 valid values for this param are included in the list given by the value
 of the pol\_states attribute of the archived dataset.
 
-\begin{table}[mht]
+\begin{table}[ht]
 \begin{tabular}{l l l}
 \sptablerule
 \textbf{SODA}&\textbf{ObsCore utypes}&\textbf{ObsCore}\cr
@@ -756,7 +769,7 @@ \subsection{Three-Factor Semantics}
 
 Table~\ref{table:freepars} is an exemple of definition of additional custom non-standard parameters.
 
-\begin{table}[mht]
+\begin{table}[ht]
 \begin{tabular}{l l l l}
 \sptablerule
 \textbf{Name}&\textbf{UCD}&\textbf{Unit}&\textbf{Semantics} \cr
@@ -774,7 +787,7 @@ \subsection{Three-Factor Semantics}
 \label{table:standardpars}
 \end{table}
 
-\begin{table}[mht]
+\begin{table}[ht]
 \begin{tabular}{l l l l}
 \sptablerule
 \textbf{Name}&\textbf{UCD}&\textbf{Unit}&\textbf{Semantics} \cr
@@ -823,7 +836,7 @@ \section{Integration of Service Capabilities}
 The DataLink recommendation provides a mechanism
 to include ``a description of a SODA service'' using a standard resource
 called a service descriptor. The service descriptor can be included in any
-VOTable \citep{std:VOTable} output and can describe the parameters for
+VOTable \citep{2013ivoa.spec.0920O} output and can describe the parameters for
 use with a DALI-sync or DALI-async compliant capability which may be a standard
  service or a custom service. Since the service descriptor can describe all input parameters,
 it can declare available standard parameters, extensions (custom
@@ -1279,6 +1292,6 @@ \subsection{Changes from WD-AccessData-1.0-20140312}
 
 This is the initial document version.
 
-\bibliography{ivoatex/ivoabib}
+\bibliography{ivoatex/ivoabib,ivoatex/docrepo}
 
 \end{document}