From 2664cc6bf68acfa0bdcda42c2e8b86c00ef3d3eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9gory=20Mantelet?= Date: Wed, 20 Nov 2024 15:19:12 +0100 Subject: [PATCH] Integrate additional modifications done in PR #15 --- .github/workflows/build.yml | 2 +- .github/workflows/preview.yml | 8 ++++---- .gitignore | 1 + README.md | 16 ++++++++++++---- role_diagram.svg | 2 +- 5 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 36ef92b..afc2817 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -25,7 +25,7 @@ jobs: 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 + run: make biblio forcetex - name: Check the output run: | diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml index 172bf7f..e565ee7 100644 --- a/.github/workflows/preview.yml +++ b/.github/workflows/preview.yml @@ -27,7 +27,7 @@ jobs: sudo snap install pdftk - name: Build the document - run: make ${{ env.doc_name }}-draft.pdf + run: make biblio ${{ env.doc_name }}-draft.pdf - name: Check the output run: | @@ -35,10 +35,10 @@ jobs: 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 }} diff --git a/.gitignore b/.gitignore index 9108e34..e400f95 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ **/ObjObsSAP.pdf **/ObjObsSAP.fls **/ObjObsSAP.fdb_latexmk +**/ObjObsSAP.toc diff --git a/README.md b/README.md index 5a58a4b..3debcda 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The Object Observability Simple Access Protocol (ObjObsSAP) is an IVOA Data Access protocol which defines the standard for retrieving object -constraint-free observability time intervals through a uniform interface within +constraint-free visibility time intervals through a uniform interface within the VO framework for given object coordinates to be observed by a given Astronomical Observatory. The ObjObsSAP services can be registered in an IVOA Registry of Resources using the VOResource, Extension standard, having @@ -12,11 +12,17 @@ a unique ResourceIdentifier in the registry. The ObjObsSAP interface is meant to be reasonably simple to be implemented by service providers. A basic query will be done introducing a set of sky coordinates and a given time period (optional). The service returns a list of constraint-free -observability time intervals formatted as VOTable. Thus, an implementation of +visibility time intervals formatted as VOTable. Thus, an implementation of the service may support additional search parameters (some of which may be custom to that particular service) to more finely control the selection of -the observability periods. The specification also describes how the search on +the visibility periods. The specification also describes how the search on extra parameters has to be done. +# Name changed + +This protocol was previously named ObjVisSAP: Object Visibility Simple Access +Protocol. It has been renamed since the +[IVOA Interoperability Meeting in Nov. 2023 in Tucson](https://wiki.ivoa.net/twiki/bin/view/IVOA/InterOpNov2023) +(see [presentation](https://wiki.ivoa.net/internal/IVOA/InterOpNov2023DAL/ObjObsSAP_IVOA2023.pdf)). # Status @@ -26,9 +32,11 @@ Under development. Remember to checkout the repository with its submodules. +```bash git clone --recurse-submodules https://github.com/ivoa-std/ObjObsSAP.git +``` -Then: run "make" and hope you have all the necessary tools installed. +Then: run `make` and hope you have all the necessary tools installed. # License diff --git a/role_diagram.svg b/role_diagram.svg index c4d77fe..874816f 100644 --- a/role_diagram.svg +++ b/role_diagram.svg @@ -48,7 +48,7 @@ DALI - ObjVisSAP + ObjObsSAP DataLink