/[volute]/trunk/projects/dm/provenance/description/ProvenanceDM.tex
ViewVC logotype

Contents of /trunk/projects/dm/provenance/description/ProvenanceDM.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4417 - (show annotations)
Tue Sep 26 21:23:46 2017 UTC (4 years, 1 month ago) by kriebe
File MIME type: application/x-tex
File size: 11670 byte(s)
Add link to previous version

1 \documentclass[11pt,a4paper]{ivoa}
2 \input tthdefs
3
4 \usepackage[utf8]{inputenc}
5 \usepackage{booktabs, tabulary} % for nicer tables
6 \usepackage[titletoc,toc,title]{appendix}
7
8 % make the text in pdf properly searchable
9 \usepackage{lmodern}
10
11 % use listings for including text files and code snippets
12 \usepackage{listings}
13 \usepackage{color}
14 \usepackage[nottoc]{tocbibind}
15
16 \definecolor{mygreen}{rgb}{0,0.6,0}
17 \definecolor{mygray}{rgb}{0.5,0.5,0.5}
18 \definecolor{mymauve}{rgb}{0.58,0,0.82}
19
20
21 \ivoagroup{DM}
22
23 \author{Kristin Riebe}
24 \author{Mathieu Servillat}
25 \author{François Bonnarel}
26 \author{Mireille Louys}
27 \author{Markus Nullmeier}
28 \author{Florian Rothmaier}
29 \author{Michèle Sanguillon}
30 \author{IVOA Data Model Working Group}
31
32 \editor{Kristin Riebe}
33 \editor{Mathieu Servillat}
34
35 % \previousversion[????URL????]{????Funny Label????}
36 \previousversion[http://www.ivoa.net/documents/ProvenanceDM/20170921/]{WD-ProvenanceDM-1.0-20170921.pdf}
37 \previousversion[http://www.ivoa.net/documents/ProvenanceDM/20161121/]{WD-ProvenanceDM-1.0-20161121.pdf}
38 \previousversion[http://volute.g-vo.org/svn/trunk/projects/dm/provenance/description/ProvDM-0.2-20160428.pdf]{ProvDM-0.2-20160428.pdf}
39 \previousversion[http://volute.g-vo.org/svn/trunk/projects/dm/provenance/description/ProvDM-0.1-20141008.pdf]{ProvDM-0.1-20141008.pdf}
40
41
42 % own definitions
43 \definecolor{todocolor}{rgb}{1,1,0.8}
44 \definecolor{darkred}{rgb}{0.6,0,0}
45 \definecolor{rose}{rgb}{1.0,0.88,0.88}
46 \definecolor{darkgrey}{rgb}{0.35,0.35,0.35}
47 %\newcommand{\TODO}[1]{%
48 % \noindent%
49 % \textcolor{todocolor}{\sffamily [\textbf{TODO:} #1]}%
50 %}
51
52 \newcommand{\TODO}[1]{%
53 \noindent%
54 \colorbox{todocolor}{%
55 \parbox{0.85\linewidth}{\sffamily \textbf{TODO:}\\
56 #1}
57 }%
58 \vspace{2pt}
59
60 }
61
62 \newcommand{\note}[1]{%
63 \noindent%
64 \textcolor{darkgrey}{{\sffamily Note:} \emph{#1}}%
65 }
66
67 \newcommand{\comment}[1]{%
68 \noindent%
69 \textcolor{red}{{\sffamily Comment:} \emph{#1}}%
70 }
71
72
73 \newcommand{\paragraphlb}[1]{\paragraph{#1}\mbox{}\\} % paragraph with line break
74
75 \setlength{\fboxsep}{5pt}
76 %\setlength{\fboxrule}{1.5pt}
77 \newcommand{\warning}[1]{%
78 \vspace{\baselineskip}
79 \noindent
80 \parbox{\linewidth}{%
81 \colorbox{darkred}{%
82 \parbox{0.7\linewidth}{\large \sffamily \textcolor{white}{Warning}}%
83 }\\[-1pt]
84 \noindent%
85 \fcolorbox{darkred}{rose}{%
86 \parbox{0.7\linewidth-2\fboxrule}{#1}%
87 }%
88 }%
89 \vspace{\baselineskip}
90 }%
91
92 % for nicer tables:
93 \renewcommand{\arraystretch}{1.3}
94 \newcommand{\head}[1]{\textbf{#1}}
95
96
97 % smaller font in verbatim:
98 \usepackage{verbatimbox}
99
100
101 % define new command for classes and other stuff, in case we decide later on for a different style
102 \newcommand{\class}[1]{\emph{#1}}
103 \newcommand{\attribute}[1]{\texttt{#1}}
104 \newcommand{\attr}[1]{\texttt{#1}} % equivalent to \attribute
105
106 \newcommand{\urlparam}[1]{{\scriptsize{#1}}}
107 \newcommand{\urlvalue}[1]{{\scriptsize{#1}}}
108
109 % from https://tex.stackexchange.com/questions/121955/help-on-dealing-with-items-divided-with-slash
110 \renewcommand{\slash}{/\penalty\exhyphenpenalty\hspace{0pt}}
111
112 \begin{document}
113 \newcolumntype{Y}{>{\raggedright\arraybackslash}X}
114
115 % define listing parameters
116 \lstdefinestyle{customc}{
117 belowcaptionskip=1\baselineskip,
118 breaklines=true,
119 frame=L,
120 %xleftmargin=\parindent,
121 language=XML,
122 showstringspaces=false,
123 basicstyle=\footnotesize,
124 keywordstyle=\bfseries\color{green!40!black},
125 %morekeywords={entity,activity, agent, used, wasGeneratedBy,prefix, ...},
126 morekeywords={agent, used, wasGeneratedBy,prefix, ...},
127 commentstyle=\color{purple!40!black},
128 identifierstyle=\color{blue},
129 %stringstyle=\color{orange},
130 stringstyle=\color{mymauve},
131 rulecolor=\color{black}
132 }
133 \lstset{escapechar=@,style=customc}
134
135
136 \title{IVOA Provenance Data Model}
137
138 \begin{abstract}
139 This document describes how provenance information for astronomical datasets
140 %(with the focus on observational data)
141 can be modeled, stored and exchanged within
142 the astronomical community in a standardized way.
143 We follow the definition of provenance as proposed by the W3C\footnote{\url{https://www.w3.org/TR/prov-overview/}}, i.e. that ``provenance is information about entities, activities, and people involved in producing a piece of data or thing, which can be used to form assessments about its quality, reliability or trustworthiness.''
144 Such provenance information in astronomy is important to enable any scientist to trace back
145 the origin of a dataset (e.g. an image, spectrum, catalog or single points in a
146 spectral energy distribution diagram or a light curve), learn about the people and
147 organizations involved in a project and assess the quality of the dataset as well
148 as the usefulness of the dataset for her own scientific work.
149 \end{abstract}
150
151
152 \section*{Acknowledgments}
153
154 This document has been developed in part with support from the German
155 Astrophysical Virtual Observatory, funded by BMBF Bewilligungsnummer 05A14BAD and 05A08VHA.
156 The Provenance Working Group acknowledges support from the Astronomy ESFRI and Research Infrastructure Cluster – ASTERICS project, funded by the European Commission under the Horizon 2020 Programme (GA 653477).
157
158 Thanks for fruitful discussions to: Catherine Boisson and Karl Kosak for the
159 binding to the Cerenkov Telescope Array (CTA) project, Gerard
160 Lemson and Laurent Michel for the VODML expression of the data model, Markus Demleitner,
161 Harry Enke, Jochen Klar, Ole Streicher, Anastasia Galkin and Adrian Partl
162 for fruitful discussions, remarks and comments during the different stages of this
163 specification.
164
165 \section*{Conformance-related definitions}
166
167 The words ``MUST'', ``SHALL'', ``SHOULD'', ``MAY'', ``RECOMMENDED'', and
168 ``OPTIONAL'' (in upper or lower case) used in this document are to be
169 interpreted as described in IETF standard, \citet{std:RFC2119}.
170
171 The \emph{Virtual Observatory (VO)} is
172 a general term for a collection of federated resources that can be used
173 to conduct astronomical research, education, and outreach.
174 The \href{http://www.ivoa.net}{International
175 Virtual Observatory Alliance (IVOA)} is a global
176 collaboration of separately funded projects to develop standards and
177 infrastructure that enable VO applications.
178
179
180 \section{Introduction}
181 \input{intro-general}
182 \input{intro-requirements}
183 \input{intro-VOarchitecture}
184 \input{intro-previousefforts}
185
186
187 \section{The provenance data model}
188 \label{sec:datamodel}
189 \input{datamodel-description}
190
191
192 % make sure that images/tables of the previous section are printed
193 % before starting the new section -- comment out, if not needed
194 % \clearpage
195 %\section{Applying provenance -- Interactions with other Data models}\label{sec:dmlinks}
196 \section{Links to other data models}
197 \label{sec:dmlinks}
198 \input{datamodel-links}
199
200
201 % make sure that images/tables of the previous section are printed
202 % before starting the new section
203 \clearpage
204 \section{Serialization of the provenance data model}
205 \label{sec:serialisations}
206 \input{serializations}
207 %\subsection{Serializing of the data model core}
208 %\label{sec:intro-serialization}
209 %\input{serialisation-intro}
210 \section{Accessing provenance information}
211 \label{sec:provaccess}
212 \input{provaccess}
213
214
215 \section{Use cases -- applying the data model}
216 %Implementations of the data model for specific use cases}
217 \label{sec:usecases-implementations}
218 \input{usecases-implementations}
219
220 \begin{appendices}
221 %\appendix
222
223 \section{Serialization Examples}
224 \label{sec:appendix-serialization-examples}
225 \input{AppendixA-ML}
226
227
228 \section{PROV-VOTable serialisation and ProvTAP TAP schema}
229 \label{sec:appendix-prov-votable}
230 \input{PROV-VOTABLE}
231
232 \section{Changes from Previous Versions}
233 \subsection{Changes from WD-ProvenanceDM-1.0-20170921}
234 \begin{itemize}
235 \item Minor corrections in Appendix~\ref{sec:appendix-serialization-examples} and Appendix~\ref{sec:appendix-prov-votable}.
236 \item Minor correction in role names in Figure~\ref{fig:classdiagram-conceptional} for hadStep/hadMember relationship.
237 \end{itemize}
238
239 \subsection{Changes from WD-ProvenanceDM-1.0-20161121}
240 \begin{itemize}
241 \item New appendix for PROV-VOTable/TAP SCHEMA tables added
242 \item Corrected and extended attribute tables and mapping tables for links with DatasetDM and SimDM.
243 \item Restructured Accessing provenance section by splitting it in two: Section~\ref{sec:serialisations} for explaining the different serialization formats and differences to W3C serializations, Section~\ref{sec:provaccess} for describing the access protocols ProvDAL and ProvTAP.
244 \item Removed discussion section, since now all the topics are addressed in the main text.
245 \item Added paragraph on how to use the model in Section~\ref{sec:usecases-implementations}.
246 \item Shortened serialization examples, partially moved them to appendix.
247 \item Added paragraph on VOSI interface.
248 \item Added a proposed serialization of description classes.
249 \item Modified text on the content of EntityDescription, now seen as Entity attributes known before the Entity instance exists.
250 \item Renamed Section~\ref{sec:usecases-implementations} to stress that it explains applications of the model (use cases); implementation details and code examples can be found in Implementation Note \citep{std:ProvenanceImplementationNote}.
251 \item Complete rewrite of the ProvDAL section in Section~\ref{sec:access_protocols}; new parameters, new figure and examples added.
252 \item Added additional figure for entity-activity relations.
253 \item Moved the figure showing relations between Provenance.Agent and Dataset.Party into Section~\ref{sec:dmlinks}.
254 \item Extended the entity role examples in table \ref{tab:entity-roles}.
255 \item Added links to provn and votable-serialization for HiPS-use case, added first part of provn as example in the HiPS-use case section.
256 \item More explanations on links to data models in Section~\ref{sec:dmlinks}, introduced subsections, added table with SimDM-mapping.
257 \item Moved detailed implementation section from appendix to a separate document (implementation note), shortened the use cases \& implementation section.
258 \item Attribute/class updates:
259 \begin{itemize}
260 \item Added attribute \emph{votype} to \class{Activity}, can be used for ActivityFlows
261 \item Added attribute \emph{time} to \class{Used} and \class{WasGeneratedBy}
262 \item Added optional attributes \emph{Entity.creationTime} and \emph{EntityDescription.category}
263 \item Added optional attributes \emph{Parameter.min}, \emph{Parameter.max}, \emph{Parameter.options}
264 \item Removed the obscore/dataset attributes from EntityDescription, since they are specific for observations only and are not applicable to configuration entities etc.
265 \item Use voprov:type and voprov:role in Table~\ref{tab:agent-roles} with example agent roles, i.e. replaced prov:person by Individual and prov:organization by Organization.
266 \item Renamed \emph{label} attribute to \emph{name} everywhere, for more consistency with SimDM naming scheme (\emph{label} is reserved there for SKOS labels).
267 \item Renamed attribute \emph{Entity.access} to \emph{Entity.rights} for more consistency with DatasetDM etc.
268 \item Avoid double-meaning of \emph{description} (as reference and free-text description) by renaming the free-text description to \emph{annotation}. Mark description-references with arrows in attribute tables.
269 \item Applied similar naming scheme to \emph{Parameter} and \emph{ParameterDescription}-classes
270 \item Renamed \emph{docuLink} to \emph{doculink}
271 \item Corrected attribute names in Table~\ref{tab:datasetmapping}.
272 \end{itemize}
273
274
275 \end{itemize}
276
277 \end{appendices}
278
279 \listoffigures
280
281 \listoftables
282
283 \bibliography{ivoatex/ivoabib,prov-refs}
284
285
286 \end{document}

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26