documentation/index.html at master · simple-access-layer/documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>Simple Access Layer (SAL) &mdash; Simple Access Layer (SAL) 1.2.2 documentation</title>


  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>


      <script type="text/javascript">
          var DOCUMENTATION_OPTIONS = {
              URL_ROOT:'./',
              VERSION:'1.2.2',
              LANGUAGE:'None',
              COLLAPSE_INDEX:false,
              FILE_SUFFIX:'.html',
              HAS_SOURCE:  true,
              SOURCELINK_SUFFIX: '.txt'
          };
      </script>
        <script type="text/javascript" src="_static/jquery.js"></script>
        <script type="text/javascript" src="_static/underscore.js"></script>
        <script type="text/javascript" src="_static/doctools.js"></script>
        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

    <script type="text/javascript" src="_static/js/theme.js"></script>


  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Clients" href="clients.html" />
</head>

<body class="wy-body-for-nav">


  <div class="wy-grid-for-nav">

    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >


            <a href="#" class="icon icon-home"> Simple Access Layer (SAL)


          </a>


              <div class="version">
                1.2.2
              </div>


<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>


        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


              <ul>
<li class="toctree-l1"><a class="reference internal" href="clients.html">Clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="server.html">Server</a></li>
<li class="toctree-l1"><a class="reference internal" href="datamodel.html">Data Model</a></li>
</ul>


        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


      <nav class="wy-nav-top" aria-label="top navigation">

          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="#">Simple Access Layer (SAL)</a>

      </nav>


      <div class="wy-nav-content">

        <div class="rst-content">


<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">

      <li><a href="#">Docs</a> &raquo;</li>

      <li>Simple Access Layer (SAL)</li>


      <li class="wy-breadcrumbs-aside">


            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>


      </li>

  </ul>


  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">

  <img alt="The SAL Logo." class="align-center" src="_images/sal_logo.png" />
<br><div class="section" id="simple-access-layer-sal">
<h1>Simple Access Layer (SAL)<a class="headerlink" href="#simple-access-layer-sal" title="Permalink to this headline">¶</a></h1>
<p>Simple Access Layer (SAL) is a data access middleware and storage system, focused on storing scientific data for large experiments. The user interface and the SAL data model are intended to be easy to learn and extend.</p>
<p>SAL has the following features:</p>
<blockquote>
<div><ul class="simple">
<li>structured data stored in a filesystem-like hierarchical organisational structure.<ul>
<li>a set of common research related data-types: signals, images, dictionaries, meshes etc…</li>
<li>support for data revisioning, storing the full history of changes to the data</li>
</ul>
</li>
<li>client/server architecture<ul>
<li>server exports an HTTP REST API</li>
<li>Python client</li>
</ul>
</li>
<li>easy to extend<ul>
<li>layered architecture<ul>
<li>plug-able authentication layer</li>
<li>plug-able storage layer</li>
</ul>
</li>
<li>Python based server</li>
</ul>
</li>
</ul>
</div></blockquote>
<p>The core of SAL is its data model. This defines the behaviour of the data system and the organisation of the data within in. The SAL server implements this data model and exposes it to users via an HTTP REST API.</p>
<p>If you are reading this documentation as a user of a SAL system, please read the data model, data classes and client sections of this documentation. If a client is not available for your chosen language the REST API can be used to access data directly, see the REST API section.</p>
<p>Administrators and developers should see the server section in addition to the sections listed above.</p>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="clients.html">Clients</a><ul>
<li class="toctree-l2"><a class="reference internal" href="client/python.html">Python Client</a></li>
<li class="toctree-l2"><a class="reference internal" href="client/c.html">C Client</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="server.html">Server</a><ul>
<li class="toctree-l2"><a class="reference internal" href="server/rest_api.html">REST API</a></li>
<li class="toctree-l2"><a class="reference internal" href="server/deployment.html">Deployment</a></li>
<li class="toctree-l2"><a class="reference internal" href="server/development.html">Development</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="datamodel.html">Data Model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="datamodel/datatree.html">Data Tree</a></li>
<li class="toctree-l2"><a class="reference internal" href="datamodel/datatree.html#permissions-tree">Permissions Tree</a></li>
<li class="toctree-l2"><a class="reference internal" href="datamodel/dataclasses.html">Data Classes</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>


           </div>

          </div>
          <footer>

    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

        <a href="clients.html" class="btn btn-neutral float-right" title="Clients" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


    </div>


  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018, European Atomic Energy Community (EURATOM)

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

        </div>
      </div>

    </section>

  </div>


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>


</body>
</html>