Skip to content

Commit

Permalink
Merge pull request #1 from mcdittmar/master
Browse files Browse the repository at this point in the history
Seed initial content of Transform Model
  • Loading branch information
lmichel authored Nov 25, 2020
2 parents bcea710 + b309e2e commit 2dc6427
Show file tree
Hide file tree
Showing 37 changed files with 9,703 additions and 2 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -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

defaults:
run:
shell: bash
working-directory: doc

env:
doc_name: Transforms

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: doc/${{ env.doc_name }}.pdf
71 changes: 71 additions & 0 deletions .github/workflows/preview.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# 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:
doc_name: Transforms

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@v1
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 }}
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#
# Project specific excludes
#
#
# Binaries

# vo-dml products
*.cmap
*.svrlt
*.gvd
*.validation-report.txt

# OS
.DS_Store

# Misc
*.swp
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "doc/ivoatex"]
path = doc/ivoatex
url = http://github.com/ivoa-std/ivoatex
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# doc-template
document template
[![PDF-Preview](https://img.shields.io/badge/PDF-Preview-blue)](https://github.com/ivoa-std/TransformDM/releases/download/auto-pdf-preview/Transforms-draft.pdf)

# What is it?
IVOA Data Model for WCS Transforms, covering the following concepts:

• The description of mathematical operations which form the building blocks for conversions from one coordinate space to another.

• The combination of individual operations into an arbitrarily complex Transform.

This model makes use of the [Astronomical Coordinates and Coordinate Systems](https://www.ivoa.net/documents/Coords/20200310/index.html) model for the description of the end point coordinate systems.

# Status
Latest stable version is [WD-1.0](https://www.ivoa.net/documents/WCSTrans/20200803/index.html)


# 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>
<br />
Expand Down
34 changes: 34 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# ivoatex Makefile. The ivoatex/README for the targets available.

# short name of your document (edit $DOCNAME.tex; would be like RegTAP)
DOCNAME = Transforms

# count up; you probably do not want to bother with versions <1.0
DOCVERSION = 1.0

# Publication date, ISO format; update manually for "releases"
DOCDATE = 2020-08-03

# What is it you're writing: NOTE, WD, PR, REC, PEN, or EN
DOCTYPE = WD

# An e-mail address of the person doing the submission to the document
# repository (can be empty until a make upload is being made)
AUTHOR_EMAIL[email protected]

# Source files for the TeX document (but the main file must always
# be called $(DOCNAME).tex
SOURCES = $(DOCNAME).tex role_diagram.pdf

# List of image files to be included in submitted package (anything that
# can be rendered directly by common web browsers)
FIGURES = role_diagram.svg

# List of PDF figures (figures that must be converted to pixel images to
# work in web browsers).
VECTORFIGURES =

# Additional files to distribute (e.g., CSS, schema files, examples...)
AUX_FILES =

include ivoatex/Makefile
Loading

0 comments on commit 2dc6427

Please sign in to comment.