Skip to content

Commit

Permalink
REC v1.2 (#9)
Browse files Browse the repository at this point in the history
* separate doc and diagrams

* rename main tex file, clean up Makefile

* step toward ivoatex Makefile

* rename files; step toward ivoatex.  no content change

* Update README.md

* rename and relocate schema

* switch to pdflatex; update diagrams to UML

* Create preview.xml

* Update README.md

* Rename preview.xml to preview.yml

* Update preview.yml

* Update preview.yml

* Update preview.yml

* Update preview.yml

* Update preview.yml

* Update preview.yml

* Update preview.yml

* add overview diagram; individual, not in doc

* add spectral order elements

* add spectral order elements

* add upper/lower limit elements

* correct case of order and relorder attributes

* fix document date

* Update README.md

add link to PDF-preview

* Update README.md

fix URL (oy!)

* Fix for Issue #6: bad utypes in example1

* Fix for Issue #5: ucd assigment for upper/lower limits

* Migrate to PR status

* Update to REC

---------

Co-authored-by: Laurent MICHEL <[email protected]>
  • Loading branch information
mcdittmar and lmichel authored Mar 12, 2024
1 parent 75ec40b commit 701c98f
Show file tree
Hide file tree
Showing 42 changed files with 19,429 additions and 863 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#
# Binaries
00spec11_clean
00spec12_clean

# LaTex products
*.pdf
Expand All @@ -14,6 +15,9 @@
*.aux
*.toc

# OS
.DS_Store

# Original Spectrum model workspace
Spectrum1.1.tar

Expand Down
54 changes: 0 additions & 54 deletions Makefile

This file was deleted.

22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,29 @@
[![PDF-Preview](https://img.shields.io/badge/PDF-Preview-blue)](https://github.com/ivoa-std/SpectrumDM/releases/download/auto-pdf-preview/Spectrum.pdf)


# Spectum DM

- This repository has been open after an IPAC request (Interop Nov 2020) for some model enhancements
A data model describing the structure of spectrophotometric datasets with spectral and temporal coordinates and associated metadata.

# Working on this Document

Clone the repository with any submodules

git clone --recurse-submodules https://github.com/ivoa-std/SpectrumDM.git

Make edits on appropriate branch and submit PR for review.

To Build PDF:

cd doc
make doc

# doc-template
# License
document template

<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 />
This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
Creative Commons Attribution-ShareAlike 4.0 International License</a>.

60 changes: 60 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Makefile for Spectrum Data Model document.

# short name of your document
DOCNAME = Spectrum

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

# Publication date, ISO format; update manually for "releases"
DOCDATE = 2023-12-15
SDATE = 20231215

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

# 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=

# Source files for the TeX document (but the main file must always
# be called $(DOCNAME).tex
SOURCES = ${DOCNAME}.tex specxml.tex specvot.tex specfits.tex fields_table.tex example_xml1.tex example_vot1.tex example_vot2.tex example_fits1.tex

# List of image files to be included in submitted package (anything that
# can be rendered directly by common web browsers)
#FIGURES = role_diagram.eps ivoa.jpg diagrams/specumln3.jpg diagrams/ndataf1.jpg diagrams/ncharf2.jpg diagrams/specstc.jpg diagrams/specu3f.jpg
FIGURES = role_diagram.eps ivoa.jpg diagrams/spectrum.png diagrams/data.png diagrams/characterization.png diagrams/coordsys.png diagrams/dataset.png diagrams/datatypes.png

# 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...)
SCHEMA = ../schema/Spectrum-1.01.xsd
AUX_FILES = ${SCHEMA}

# ================================================================================
FILES = ${SOURCES} ${SCHEMA} specrc3.html ${FIGURES}
HFILES = SpectrumDM-${SDATE}.pdf SpectrumDM-${SDATE}.html ${SCHEMA} ${FIGURES}

clean:
rm -f Spectrum.pdf Spectrum.ps Spectrum.log Spectrum.dvi Spectrum.out Spectrum.aux Spectrum.toc

doc: Spectrum.tex
pdflatex Spectrum
pdflatex Spectrum
cp Spectrum.pdf SpectrumDM-${SDATE}.pdf

html:
vohtml Spectrum h
rm -f SpectrumDM-${SDATE}.html
cp h/Spectrum.html SpectrumDM-${SDATE}.html

pack:
tar cvzf vospec.tgz ${FILES}

ivoa: doc html pack
tar cvzf ivoa.tgz ${HFILES}

Loading

0 comments on commit 701c98f

Please sign in to comment.