From 4b09f858b3fd79b571f64b893a0bedf4a4998c97 Mon Sep 17 00:00:00 2001 From: John Swinbank <swinbank@astron.nl> Date: Sat, 17 Dec 2022 10:33:47 +0100 Subject: [PATCH] Add intro & draft structure --- contents/1-intro.tex | 39 ++++++++++++++++++++++++++++++++++++- contents/2-vision.tex | 2 ++ contents/3-current.tex | 2 ++ contents/4-requirements.tex | 2 ++ contents/5-usecases.tex | 2 ++ contents/6-esfri.tex | 2 ++ contents/7-future.tex | 2 ++ contents/8-conclusions.tex | 2 ++ main.tex | 2 ++ 9 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 contents/2-vision.tex create mode 100644 contents/3-current.tex create mode 100644 contents/4-requirements.tex create mode 100644 contents/5-usecases.tex create mode 100644 contents/6-esfri.tex create mode 100644 contents/7-future.tex create mode 100644 contents/8-conclusions.tex diff --git a/contents/1-intro.tex b/contents/1-intro.tex index 5ee170e..13d6c9b 100644 --- a/contents/1-intro.tex +++ b/contents/1-intro.tex @@ -1,4 +1,41 @@ \section{Introduction} \label{sec:intro} -Introduction. +This document is \gls{ESCAPE} project deliverable \docNumber{}: “\docTitle{}” \autocite{ESCAPE-GA}. + +\Pgls{ESAP} is the primary deliverable of \gls{ESCAPE} \Acrlong{WP} 5 (\Acrshort{WP}5\glsunset{WP}). +A fundamentally web-based application, it serves a key part of the interface between the services delivered by \gls{ESCAPE} and the scientific community, providing mechanisms by which users can discover, access, and analyze the data, workflows, and services which the \glspl{ESFRI} affiliated with \gls{ESCAPE}, as well as other research infrastructures and a diverse range of other service providers, publish to the \gls{EOSC}. + +At the time of writing, the funded \gls{ESCAPE} project is reaching its conclusion. +Substantial development effort has been invested into \gls{ESAP} and the surrounding ecosystem of software and services. +At the same time, we do not believe that the development of \gls{ESAP} itself is coming to an end: the technologies developed, and the workflows pioneered, have shown real potential for widespread future application. +This makes it an opportune moment to step back and assess the current state of and future plans for \gls{ESAP}. +What have we achieved within the context of \gls{ESCAPE} so far? +How can we build upon these achievements in the future? +It is that analysis which is undertaken in this document. + +At the mid-point of \gls{ESCAPE}, we undertook a substantial analysis of the performance of the \gls{ESAP} system as it then stood \autocite{ESCAPE-D5.3}. +This document builds upon that earlier work to describe the sum total of the work achieved across the full duration of the project. +Specifically, we will consider: + +\begin{enumerate} + +\item{To what extent the prototype meets the requirements which were specified in \citetitle{ESCAPE-D5.2} \autocite{ESCAPE-D5.2}?} + +\item{To what extent the prototype meets the needs currently being expressed by the \gls{ESCAPE}-affiliated \glspl{ESFRI}, as expressed through the use cases collated by the project?} + +\item{To what extent have \gls{ESFRI} or other services have been successfully integrated with \gls{ESAP}?} + +\item{What are the future plans for \gls{ESAP} development as the \gls{ESCAPE} project comes to its conclusion?} + +\end{enumerate} + +Broadly, this report is structured in two parts. +In the first part, we provide essential context by describing the \gls{ESAP} system. +In \cref{sec:vision} we the overall vision for the \gls{ESAP} system: what did we set out to build? +\Cref{sec:current} takes that further by describing what is currently available: if one were to deploy and operate an \gls{ESAP} system today, what would it consist of? + +The second part of this document moves on to asses how successful that vision and implementation have been in addressing user --- and in particular \gls{ESFRI} --- needs. +In particular, \cref{sec:requirements} tabulates the documented requirements and compares them to delivered product; \cref{sec:usecases} discusses how \pgls{ESAP} relates to all the use cases collected by the \gls{ESCAPE} project; and \cref{sec:esfri} describes current \gls{ESFRI} engagement with the platform.. + +Finally, we consider potential future enhancements in \cref{sec:future}, and provide a summary of the results of this analysis is presented in \cref{sec:conclusions}. diff --git a/contents/2-vision.tex b/contents/2-vision.tex new file mode 100644 index 0000000..50bb355 --- /dev/null +++ b/contents/2-vision.tex @@ -0,0 +1,2 @@ +\section{The \glsentrytext{ESAP} Vision} +\label{sec:vision} diff --git a/contents/3-current.tex b/contents/3-current.tex new file mode 100644 index 0000000..c9f0c84 --- /dev/null +++ b/contents/3-current.tex @@ -0,0 +1,2 @@ +\section{Current Capabilities} +\label{sec:current} diff --git a/contents/4-requirements.tex b/contents/4-requirements.tex new file mode 100644 index 0000000..c5f0b80 --- /dev/null +++ b/contents/4-requirements.tex @@ -0,0 +1,2 @@ +\section{Requirements Analysis} +\label{sec:requirements} diff --git a/contents/5-usecases.tex b/contents/5-usecases.tex new file mode 100644 index 0000000..fd154f1 --- /dev/null +++ b/contents/5-usecases.tex @@ -0,0 +1,2 @@ +\section{Use Case Analysis} +\label{sec:usecases} diff --git a/contents/6-esfri.tex b/contents/6-esfri.tex new file mode 100644 index 0000000..138c7b6 --- /dev/null +++ b/contents/6-esfri.tex @@ -0,0 +1,2 @@ +\section{ESFRI Users} +\label{sec:esfri} diff --git a/contents/7-future.tex b/contents/7-future.tex new file mode 100644 index 0000000..c341738 --- /dev/null +++ b/contents/7-future.tex @@ -0,0 +1,2 @@ +\section{Future Prospects} +\label{sec:future} diff --git a/contents/8-conclusions.tex b/contents/8-conclusions.tex new file mode 100644 index 0000000..a5ff4c8 --- /dev/null +++ b/contents/8-conclusions.tex @@ -0,0 +1,2 @@ +\section{Conclusions} +\label{sec:conclusions} diff --git a/main.tex b/main.tex index 027d8e7..d3a3f05 100644 --- a/main.tex +++ b/main.tex @@ -13,6 +13,8 @@ \setDueDate{2022-11-30} \setDueMonth{M46} +\glsunset{ESFRI} + % This is set according to information obtained from make and git. \setDocDate{\vcsDate} -- GitLab