diff --git a/docs/access-node-api.md b/docs/access-node-api.md
deleted file mode 100644
index 64d20eb40cb071a74337ed5cd3ce86c2eea9de2a..0000000000000000000000000000000000000000
--- a/docs/access-node-api.md
+++ /dev/null
@@ -1,413 +0,0 @@
-# In-Situ Pipeline REST API
-This is the REST API for the in-situ pipeline.
-
-## Version: 0.1.0
-
-### /arbor/spikes
-
-#### GET
-##### Summary:
-
-Retrieves the spikes for the given simulation times (optional), cell and segment (optional).
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-| from | query | The start time (including) to be queried. | No | double |
-| to | query | The end time (excluding) to be queried. | No | double |
-| cell_ids | query | A list of cell ids queried for spike data. | No | [ integer (uint64) ] |
-| segment_ids | query | A list of segment ids queried for spike data. | No | [ integer (uint64) ] |
-| offset | query | The offset into the result. | No | integer (uint64) |
-| limit | query | The maximum of entries to be result. | No | integer (uint64) |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [Spikes](#spikes) |
-| 400 | Operation failed. | string |
-
-### /arbor/cell_ids
-
-#### GET
-##### Summary:
-
-Retrieves a list of all cell ids.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [ integer (uint64) ] |
-| 400 | Operation failed. | string |
-
-### /arbor/probes
-
-#### GET
-##### Summary:
-
-Retrieves a list of all probes for a given attribute (optional).
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-| attribute | query | The attribute measured for which existing probes will be returned. | No | string |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [ [Probe](#probe) ] |
-| 400 | Operation failed. | string |
-
-### /arbor/attributes
-
-#### GET
-##### Summary:
-
-Retrieves a list of all attributes.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [ string ] |
-| 400 | Operation failed. | string |
-
-### /arbor/measurements
-
-#### GET
-##### Summary:
-
-Retrieves the measurements for given probes (optional).
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-| attribute | query | The attribute to query | Yes | string |
-| probe_ids | query | A list of probes ids queried for data. | No | [ integer (uint64) ] |
-| from | query | The start time (including) to be queried. | No | double |
-| to | query | The end time (excluding) to be queried. | No | double |
-| offset | query | The offset into the result. | No | integer (uint64) |
-| limit | query | The maximum of entries to be returned. | No | integer (uint64) |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [ArborMeasurement](#arbormeasurement) |
-| 400 | Operation failed. | string |
-
-### /arbor/simulation_time_info
-
-#### GET
-##### Summary:
-
-Retrieves simulation time information(begin, current, end).
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [SimulationTimeInfo](#simulationtimeinfo) |
-| 400 | Operation failed. | string |
-
-### /arbor/cell_properties
-
-#### GET
-##### Summary:
-
-Retrieves the properties of the specified cells.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-| cell_ids | query | A list of cell IDs queried for properties. | No | [ integer (uint64) ] |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [ [ArborCellProperties](#arborcellproperties) ] |
-| 400 | Operation failed. | string |
-
-### /nest/simulation_time_info
-
-#### GET
-##### Summary:
-
-Retrieves simulation time information (step_size, begin, current, end).
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [SimulationTimeInfo](#simulationtimeinfo) |
-| 400 | Operation failed. | string |
-
-### /nest/gids
-
-#### GET
-##### Summary:
-
-Retrieves a list of all gids.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [ integer (uint64) ] |
-| 400 | Operation failed. | string |
-
-### /nest/neuron_properties
-
-#### GET
-##### Summary:
-
-Retrieves the properties of the specified neurons.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-| gids | query | A list of gids queried for properties. | No | [ integer (uint64) ] |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [ [NestNeuronProperties](#nestneuronproperties) ] |
-| 400 | Operation failed. | string |
-
-### /nest/populations
-
-#### GET
-##### Summary:
-
-Retrieves a list of all population IDs.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [ integer (uint64) ] |
-| 400 | Operation failed. | string |
-
-### /nest/spikes
-
-#### GET
-##### Summary:
-
-Retrieves the spikes for the given simulation steps (optional) and gids (optional).
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-| from | query | The start time (including) to be queried. | No | double |
-| to | query | The end time (excluding) to be queried. | No | double |
-| gids | query | A list of gids queried for spike data. | No | [ integer (uint64) ] |
-| offset | query | The offset into the result. | No | integer (uint64) |
-| limit | query | The maximum of entries to be returned. | No | integer (uint64) |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [Spikes](#spikes) |
-| 400 | Operation failed. | string |
-
-### /nest/population/${population_id}/spikes
-
-#### GET
-##### Summary:
-
-Retrieves the spikes for the given simulation steps (optional) and population.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-| population_id | path | The identifier of the population. | Yes | integer (uint64) |
-| from | query | The start time (including) to be queried. | No | double |
-| to | query | The end time (excluding) to be queried. | No | double |
-| offset | query | The offset into the result. | No | integer (uint64) |
-| limit | query | The maximum of entries to be returned. | No | integer (uint64) |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [Spikes](#spikes) |
-| 400 | Operation failed. | string |
-
-### /nest/multimeter_info
-
-#### GET
-##### Summary:
-
-Retreives the available multimeters and their properties.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [MultimeterInfo](#multimeterinfo) |
-| 400 | Operation failed. | string |
-
-### /nest/multimeter_measurement
-
-#### GET
-##### Summary:
-
-Retrieves the measurements for a multimeter, attribute and gids (optional).
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-| multimeter_id | query | The multimeter to query | Yes | integer (uint64) |
-| attribute | query | The attribute to query (e.g., 'V_m' for the membrane potential) | Yes | string |
-| from | query | The start time (including) to be queried. | No | double |
-| to | query | The end time (excluding) to be queried. | No | double |
-| gids | query | A list of gids queried for spike data. | No | [ integer (uint64) ] |
-| offset | query | The offset into the result. | No | integer (uint64) |
-| limit | query | The maximum of entries to be result. | No | integer (uint64) |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [MultimeterMeasurement](#multimetermeasurement) |
-| 400 | Operation failed. | string |
-
-### /nest/population/${population_id}/gids
-
-#### GET
-##### Summary:
-
-Retrieves the list of all neuron ids within the population.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ---- |
-| population_id | path | The identifier of the population | Yes | integer (uint64) |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | Operation successful. | [ integer (uint64) ] |
-| 400 | Operation failed. | string |
-
-### Models
-
-
-#### Spikes
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| simulation_times | [ double ] | This array is always sorted. | No |
-| gids | [ integer (uint64) ] | | No |
-
-#### MultimeterInfo
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| MultimeterInfo | array | | |
-
-#### MultimeterMeasurement
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| simulation_times | [ double ] | This array is always sorted. | No |
-| gids | [ integer (uint64) ] | | No |
-| values | [ number ] | This array contains the measured values for each gid and time to get the value for gid n at time t you have to use the index n * length(simulation_times) + t | No |
-
-#### ArborMeasurement
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| simulation_times | [ double ] | This array is always sorted. | No |
-| gids | [ integer (uint64) ] | | No |
-| values | [ number ] | This array contains the measured values for each gid and time to get the value for gid n at time t you have to use the index n * length(simulation_times) + t | No |
-
-#### Probe
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | integer (uint64) | | No |
-| cell_id | integer (uint64) | | No |
-| segment_id | integer (uint64) | | No |
-| position | double | | No |
-
-#### ArborCellProperties
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| neuron_id | integer (uint64) | | No |
-| properties | object | | No |
-
-#### NestNeuronProperties
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| gid | integer (uint64) | | No |
-| properties | object | | No |
-
-#### SimulationTimeInfo
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| step_size | double | | No |
-| begin | double | | No |
-| end | double | | No |
-| current | double | | No |
-
-#### MultimeterInfo_inner
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | integer (uint64) | | No |
-| attributes | [ string ] | | No |
-| gids | [ integer (uint64) ] | | No |
\ No newline at end of file
diff --git a/docs/api/index.md b/docs/api/index.md
deleted file mode 100644
index c087fc8e7cedb1caea19e1a51c7183970ab0a085..0000000000000000000000000000000000000000
--- a/docs/api/index.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# Insite API Specification
-* [Version 1](v1/index.html)
diff --git a/docs/api/v1/index.html b/docs/api/v1/index.html
deleted file mode 100644
index 3dedcb3988c14e3a6bb7760a84bbf61168d4bf94..0000000000000000000000000000000000000000
--- a/docs/api/v1/index.html
+++ /dev/null
@@ -1,1297 +0,0 @@
-<!doctype html>
-<html>
- <head>
- <title>In-Situ Pipeline REST API</title>
- <style type="text/css">
- body {
- font-family: Trebuchet MS, sans-serif;
- font-size: 15px;
- color: #444;
- margin-right: 24px;
-}
-
-h1 {
- font-size: 25px;
-}
-h2 {
- font-size: 20px;
-}
-h3 {
- font-size: 16px;
- font-weight: bold;
-}
-hr {
- height: 1px;
- border: 0;
- color: #ddd;
- background-color: #ddd;
-}
-
-.app-desc {
- clear: both;
- margin-left: 20px;
-}
-.param-name {
- width: 100%;
-}
-.license-info {
- margin-left: 20px;
-}
-
-.license-url {
- margin-left: 20px;
-}
-
-.model {
- margin: 0 0 0px 20px;
-}
-
-.method {
- margin-left: 20px;
-}
-
-.method-notes {
- margin: 10px 0 20px 0;
- font-size: 90%;
- color: #555;
-}
-
-pre {
- padding: 10px;
- margin-bottom: 2px;
-}
-
-.http-method {
- text-transform: uppercase;
-}
-
-pre.get {
- background-color: #0f6ab4;
-}
-
-pre.post {
- background-color: #10a54a;
-}
-
-pre.put {
- background-color: #c5862b;
-}
-
-pre.delete {
- background-color: #a41e22;
-}
-
-.huge {
- color: #fff;
-}
-
-pre.example {
- background-color: #f3f3f3;
- padding: 10px;
- border: 1px solid #ddd;
-}
-
-code {
- white-space: pre;
-}
-
-.nickname {
- font-weight: bold;
-}
-
-.method-path {
- font-size: 1.5em;
- background-color: #0f6ab4;
-}
-
-.up {
- float:right;
-}
-
-.parameter {
- width: 500px;
-}
-
-.param {
- width: 500px;
- padding: 10px 0 0 20px;
- font-weight: bold;
-}
-
-.param-desc {
- width: 700px;
- padding: 0 0 0 20px;
- color: #777;
-}
-
-.param-type {
- font-style: italic;
-}
-
-.param-enum-header {
-width: 700px;
-padding: 0 0 0 60px;
-color: #777;
-font-weight: bold;
-}
-
-.param-enum {
-width: 700px;
-padding: 0 0 0 80px;
-color: #777;
-font-style: italic;
-}
-
-.field-label {
- padding: 0;
- margin: 0;
- clear: both;
-}
-
-.field-items {
- padding: 0 0 15px 0;
- margin-bottom: 15px;
-}
-
-.return-type {
- clear: both;
- padding-bottom: 10px;
-}
-
-.param-header {
- font-weight: bold;
-}
-
-.method-tags {
- text-align: right;
-}
-
-.method-tag {
- background: none repeat scroll 0% 0% #24A600;
- border-radius: 3px;
- padding: 2px 10px;
- margin: 2px;
- color: #FFF;
- display: inline-block;
- text-decoration: none;
-}
-
- </style>
- </head>
- <body>
- <h1>In-Situ Pipeline REST API</h1>
- <div class="app-desc">This is the REST API for the in-situ pipeline.</div>
- <div class="app-desc">More information: <a href="https://openapi-generator.tech">https://openapi-generator.tech</a></div>
- <div class="app-desc">Contact Info: <a href="team@openapitools.org">team@openapitools.org</a></div>
- <div class="app-desc">Version: 1.0.0</div>
- <div class="app-desc">BasePath:/v1</div>
- <div class="license-info">All rights reserved</div>
- <div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div>
- <h2>Access</h2>
-
- <h2><a name="__Methods">Methods</a></h2>
- [ Jump to <a href="#__Models">Models</a> ]
-
- <h3>Table of Contents </h3>
- <div class="method-summary"></div>
- <h4><a href="#Default">Default</a></h4>
- <ul>
- <li><a href="#getVersion"><code><span class="http-method">get</span> /version</code></a></li>
- </ul>
- <h4><a href="#Nest">Nest</a></h4>
- <ul>
- <li><a href="#nestGetKernelStatus"><code><span class="http-method">get</span> /nest/kernelStatus</code></a></li>
- <li><a href="#nestGetMultimeterById"><code><span class="http-method">get</span> /nest/multimeters/{multimeterId}</code></a></li>
- <li><a href="#nestGetMultimeterMeasurements"><code><span class="http-method">get</span> /nest/multimeters/{multimeterId}/attributes/{attributeName}</code></a></li>
- <li><a href="#nestGetMultimeters"><code><span class="http-method">get</span> /nest/multimeters</code></a></li>
- <li><a href="#nestGetNodeById"><code><span class="http-method">get</span> /nest/nodes/{nodeId}</code></a></li>
- <li><a href="#nestGetNodeCollections"><code><span class="http-method">get</span> /nest/nodeCollections</code></a></li>
- <li><a href="#nestGetNodeIds"><code><span class="http-method">get</span> /nest/nodes/ids</code></a></li>
- <li><a href="#nestGetNodeIdsByNodeCollection"><code><span class="http-method">get</span> /nest/nodeCollections/{nodeCollectionId}/nodes/ids</code></a></li>
- <li><a href="#nestGetNodes"><code><span class="http-method">get</span> /nest/nodes</code></a></li>
- <li><a href="#nestGetNodesByNodeCollection"><code><span class="http-method">get</span> /nest/nodeCollections/{nodeCollectionId}/nodes</code></a></li>
- <li><a href="#nestGetSimulationTimeInfo"><code><span class="http-method">get</span> /nest/simulationTimeInfo</code></a></li>
- <li><a href="#nestGetSpikedetectors"><code><span class="http-method">get</span> /nest/spikedetectors/</code></a></li>
- <li><a href="#nestGetSpikes"><code><span class="http-method">get</span> /nest/spikes</code></a></li>
- <li><a href="#nestGetSpikesByNodeCollection"><code><span class="http-method">get</span> /nest/nodeCollections/{nodeCollectionId}/spikes</code></a></li>
- <li><a href="#nestGetSpikesBySpikedetector"><code><span class="http-method">get</span> /nest/spikedetectors/{spikedetectorId}/spikes</code></a></li>
- </ul>
-
- <h1><a name="Default">Default</a></h1>
- <div class="method"><a name="getVersion"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /version</code></pre></div>
- <div class="method-summary">Returns the deployed insite and API versions. (<span class="nickname">getVersion</span>)</div>
- <div class="method-notes"></div>
-
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- <a href="#Version">Version</a>
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "api" : {
- "v1" : "1.3",
- "v2" : "2.1",
- "v3" : "3.5"
- },
- "insite" : "4.6"
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
- <a href="#Version">Version</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <h1><a name="Nest">Nest</a></h1>
- <div class="method"><a name="nestGetKernelStatus"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/kernelStatus</code></pre></div>
- <div class="method-summary">Retreives the current status of the NEST kernel. (<span class="nickname">nestGetKernelStatus</span>)</div>
- <div class="method-notes"></div>
-
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
-
- Object
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "T_max" : 1.1529215046068468E15,
- "T_min" : -1.1529215046068468E15,
- "adaptive_spike_buffers" : true,
- "adaptive_target_buffers" : true,
- "buffer_size_secondary_events" : 0,
- "buffer_size_spike_data" : 42,
- "buffer_size_target_data" : 125,
- "data_path" : "",
- "data_prefix" : "",
- "dict_miss_is_error" : true,
- "grng_seed" : 0,
- "growth_factor_buffer_spike_data" : 1.5,
- "growth_factor_buffer_target_data" : 1.5,
- "keep_source_table" : true,
- "local_num_threads" : 1,
- "local_spike_counter" : 745,
- "max_buffer_size_spike_data" : 8388608,
- "max_buffer_size_target_data" : 16777216,
- "max_delay" : 1.5,
- "max_num_syn_models" : 512,
- "min_delay" : 1.5,
- "ms_per_tic" : 0.001,
- "network_size" : 128,
- "num_connections" : 1750,
- "num_processes" : 1,
- "off_grid_spiking" : false,
- "overwrite_files" : true,
- "print_time" : false,
- "recording_backends" : {
- "ascii" : { },
- "insite" : { },
- "memory" : { },
- "screen" : { }
- },
- "resolution" : 0.1,
- "rng_seeds" : [ 1 ],
- "sort_connections_by_source" : true,
- "structural_plasticity_synapses" : { },
- "structural_plasticity_update_interval" : 10000,
- "tics_per_ms" : 1000,
- "tics_per_step" : 100,
- "time" : 100,
- "time_collocate" : 0,
- "time_communicate" : 0,
- "to_do" : 0,
- "total_num_virtual_procs" : 1,
- "use_wfr" : true,
- "wfr_comm_interval" : 1,
- "wfr_interpolation_order" : 3,
- "wfr_max_iterations" : 15,
- "wfr_tol" : 1.0E-4
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
- <a href="#Object">Object</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetMultimeterById"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/multimeters/{multimeterId}</code></pre></div>
- <div class="method-summary">Retreives the available multimeters and their properties. (<span class="nickname">nestGetMultimeterById</span>)</div>
- <div class="method-notes"></div>
-
- <h3 class="field-label">Path parameters</h3>
- <div class="field-items">
- <div class="param">multimeterId (required)</div>
-
- <div class="param-desc"><span class="param-type">Path Parameter</span> — The identifier of the multimeter. default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- <a href="#MultimeterInfo">MultimeterInfo</a>
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "multimeterId" : 10,
- "attributes" : [ "V_m" ],
- "nodeIds" : [ 1, 3, 5 ]
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
- <a href="#MultimeterInfo">MultimeterInfo</a>
- <h4 class="field-label">400</h4>
- Operation failed due to invalid request.
- <a href="#ErrorResponse">ErrorResponse</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetMultimeterMeasurements"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/multimeters/{multimeterId}/attributes/{attributeName}</code></pre></div>
- <div class="method-summary">Retrieves the measurements for a multimeter, attribute and node IDs (optional). (<span class="nickname">nestGetMultimeterMeasurements</span>)</div>
- <div class="method-notes"></div>
-
- <h3 class="field-label">Path parameters</h3>
- <div class="field-items">
- <div class="param">multimeterId (required)</div>
-
- <div class="param-desc"><span class="param-type">Path Parameter</span> — The multimeter to query default: null format: uint64</div><div class="param">attributeName (required)</div>
-
- <div class="param-desc"><span class="param-type">Path Parameter</span> — The attribute to query (e.g., 'V_m' for the membrane potential) default: null </div>
- </div> <!-- field-items -->
-
-
-
-
- <h3 class="field-label">Query parameters</h3>
- <div class="field-items">
- <div class="param">fromTime (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The start time (including) to be queried. default: null format: double</div><div class="param">toTime (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The end time (excluding) to be queried. default: null format: double</div><div class="param">nodeIds (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — A list of node IDs queried for attribute data. default: null format: uint64</div><div class="param">skip (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The offset into the result. default: null format: uint64</div><div class="param">top (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The maximum number of entries to be returned. default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- <a href="#MultimeterMeasurement">MultimeterMeasurement</a>
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "simulationTimes" : [ 0.1, 0.2 ],
- "nodeIds" : [ 1, 2, 3 ],
- "values" : [ 0.123, 0.123, 0.123, 0.123, 0.123, 0.123 ]
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
- <a href="#MultimeterMeasurement">MultimeterMeasurement</a>
- <h4 class="field-label">400</h4>
- Operation failed due to invalid request.
- <a href="#ErrorResponse">ErrorResponse</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetMultimeters"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/multimeters</code></pre></div>
- <div class="method-summary">Retreives the available multimeters and their properties. (<span class="nickname">nestGetMultimeters</span>)</div>
- <div class="method-notes"></div>
-
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- array[<a href="#MultimeterInfo">MultimeterInfo</a>]
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "multimeterId" : 10,
- "attributes" : [ "V_m" ],
- "nodeIds" : [ 1, 3, 5 ]
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
-
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetNodeById"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/nodes/{nodeId}</code></pre></div>
- <div class="method-summary">Retrieves the properties of the specified node. (<span class="nickname">nestGetNodeById</span>)</div>
- <div class="method-notes"></div>
-
- <h3 class="field-label">Path parameters</h3>
- <div class="field-items">
- <div class="param">nodeId (required)</div>
-
- <div class="param-desc"><span class="param-type">Path Parameter</span> — The ID of the queried node. default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- <a href="#NestNodeProperties">NestNodeProperties</a>
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "nodeId" : 1,
- "nodeCollectionId" : 0,
- "simulationNodeId" : 0,
- "position" : [ 0.1, 0.2 ],
- "model" : "iaf_psc_delta",
- "status" : {
- "C_m" : 1,
- "Ca" : 0,
- "E_L" : 0,
- "I_e" : 0,
- "V_m" : 0,
- "V_min" : -1.7976931348623157E308,
- "V_reset" : 0,
- "V_th" : 20,
- "archiver_length" : 0,
- "beta_Ca" : 0.001
- }
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
- <a href="#NestNodeProperties">NestNodeProperties</a>
- <h4 class="field-label">400</h4>
- Operation failed due to invalid request.
- <a href="#ErrorResponse">ErrorResponse</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetNodeCollections"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/nodeCollections</code></pre></div>
- <div class="method-summary">Retrieves a list of all node collection IDs. (<span class="nickname">nestGetNodeCollections</span>)</div>
- <div class="method-notes"></div>
-
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- array[<a href="#NestNodeCollectionProperties">NestNodeCollectionProperties</a>]
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "nodeCollectionId" : 0,
- "nodes" : {
- "firstId" : 1,
- "lastId" : 100,
- "count" : 100
- },
- "model" : {
- "name" : "iaf_psc_delta",
- "status" : {
- "C_m" : "1,",
- "Ca" : "0,",
- "E_L" : "0,",
- "I_e" : "0,",
- "V_m" : "0,",
- "V_min" : "-1.7976931348623157e+308,",
- "V_reset" : "0,",
- "V_th" : "20,"
- }
- }
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
-
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetNodeIds"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/nodes/ids</code></pre></div>
- <div class="method-summary">Retrieves a list of all node IDs. (<span class="nickname">nestGetNodeIds</span>)</div>
- <div class="method-notes"></div>
-
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
-
- array[Integer]
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>[ 1, 2, 3, 4 ]</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
-
- <h4 class="field-label">500</h4>
- Operation failed.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetNodeIdsByNodeCollection"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/nodeCollections/{nodeCollectionId}/nodes/ids</code></pre></div>
- <div class="method-summary">Retrieves the list of all node ids within the node collection. (<span class="nickname">nestGetNodeIdsByNodeCollection</span>)</div>
- <div class="method-notes"></div>
-
- <h3 class="field-label">Path parameters</h3>
- <div class="field-items">
- <div class="param">nodeCollectionId (required)</div>
-
- <div class="param-desc"><span class="param-type">Path Parameter</span> — The identifier of the node collection default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
-
- array[Integer]
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>[ 1, 2 ]</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
-
- <h4 class="field-label">400</h4>
- Operation failed due to invalid request.
- <a href="#ErrorResponse">ErrorResponse</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetNodes"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/nodes</code></pre></div>
- <div class="method-summary">Retrieves all nodes of the simulation. (<span class="nickname">nestGetNodes</span>)</div>
- <div class="method-notes"></div>
-
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- array[<a href="#NestNodeProperties">NestNodeProperties</a>]
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "nodeId" : 1,
- "nodeCollectionId" : 0,
- "simulationNodeId" : 0,
- "position" : [ 0.1, 0.2 ],
- "model" : "iaf_psc_delta",
- "status" : {
- "C_m" : 1,
- "Ca" : 0,
- "E_L" : 0,
- "I_e" : 0,
- "V_m" : 0,
- "V_min" : -1.7976931348623157E308,
- "V_reset" : 0,
- "V_th" : 20,
- "archiver_length" : 0,
- "beta_Ca" : 0.001
- }
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
-
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetNodesByNodeCollection"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/nodeCollections/{nodeCollectionId}/nodes</code></pre></div>
- <div class="method-summary">Retrieves the list of all node within the node collection. (<span class="nickname">nestGetNodesByNodeCollection</span>)</div>
- <div class="method-notes"></div>
-
- <h3 class="field-label">Path parameters</h3>
- <div class="field-items">
- <div class="param">nodeCollectionId (required)</div>
-
- <div class="param-desc"><span class="param-type">Path Parameter</span> — The identifier of the node collection default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- array[<a href="#NestNodeProperties">NestNodeProperties</a>]
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "nodeId" : 1,
- "nodeCollectionId" : 0,
- "simulationNodeId" : 0,
- "position" : [ 0.1, 0.2 ],
- "model" : "iaf_psc_delta",
- "status" : {
- "C_m" : 1,
- "Ca" : 0,
- "E_L" : 0,
- "I_e" : 0,
- "V_m" : 0,
- "V_min" : -1.7976931348623157E308,
- "V_reset" : 0,
- "V_th" : 20,
- "archiver_length" : 0,
- "beta_Ca" : 0.001
- }
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
-
- <h4 class="field-label">400</h4>
- Operation failed due to invalid request.
- <a href="#ErrorResponse">ErrorResponse</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetSimulationTimeInfo"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/simulationTimeInfo</code></pre></div>
- <div class="method-summary">Retrieves simulation time information (stepSize, begin, current, end). (<span class="nickname">nestGetSimulationTimeInfo</span>)</div>
- <div class="method-notes"></div>
-
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- <a href="#SimulationTimeInfo">SimulationTimeInfo</a>
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "stepSize" : 0.1,
- "current" : 2.1,
- "begin" : 0.1,
- "end" : 4.5
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
- <a href="#SimulationTimeInfo">SimulationTimeInfo</a>
- <h4 class="field-label">500</h4>
- Operation failed.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetSpikedetectors"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/spikedetectors/</code></pre></div>
- <div class="method-summary">Queries all spike detectors accessable to the pipeline. (<span class="nickname">nestGetSpikedetectors</span>)</div>
- <div class="method-notes"></div>
-
-
-
-
-
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- array[<a href="#SpikedetectorInfo">SpikedetectorInfo</a>]
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "spikedetectorId" : 0,
- "nodeIds" : [ 1, 3, 5 ]
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
-
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetSpikes"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/spikes</code></pre></div>
- <div class="method-summary">Retrieves the spikes for the given time range (optional) and node IDs (optional). If no time range or node list is specified, it will return the spikes for whole time or all nodes respectively. This request merges the spikes recorded by all spike detectors and removes duplicates. (<span class="nickname">nestGetSpikes</span>)</div>
- <div class="method-notes"></div>
-
-
-
-
-
- <h3 class="field-label">Query parameters</h3>
- <div class="field-items">
- <div class="param">fromTime (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The start time in milliseconds (including) to be queried. default: null format: double</div><div class="param">toTime (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The end time in milliseconds (excluding) to be queried. default: null format: double</div><div class="param">nodeIds (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — A list of node IDs queried for spike data. default: null format: uint64</div><div class="param">skip (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The offset into the result. default: null format: uint64</div><div class="param">top (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The maximum number of entries to be returned. default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- <a href="#Spikes">Spikes</a>
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "simulationTimes" : [ 0.8, 0.9 ],
- "nodeIds" : [ 1, 2 ]
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
- <a href="#Spikes">Spikes</a>
- <h4 class="field-label">400</h4>
- Operation failed due to invalid request.
- <a href="#ErrorResponse">ErrorResponse</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetSpikesByNodeCollection"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/nodeCollections/{nodeCollectionId}/spikes</code></pre></div>
- <div class="method-summary">Retrieves the spikes for the given simulation steps (optional) and node collection. This request merges the spikes recorded by all spike detectors and removes duplicates. (<span class="nickname">nestGetSpikesByNodeCollection</span>)</div>
- <div class="method-notes"></div>
-
- <h3 class="field-label">Path parameters</h3>
- <div class="field-items">
- <div class="param">nodeCollectionId (required)</div>
-
- <div class="param-desc"><span class="param-type">Path Parameter</span> — The identifier of the node collection. default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
-
-
- <h3 class="field-label">Query parameters</h3>
- <div class="field-items">
- <div class="param">fromTime (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The start time (including) to be queried. default: null format: double</div><div class="param">toTime (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The end time (excluding) to be queried. default: null format: double</div><div class="param">skip (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The offset into the result. default: null format: uint64</div><div class="param">top (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The maximum numbers of entries to be returned. default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- <a href="#Spikes">Spikes</a>
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "simulationTimes" : [ 0.8, 0.9 ],
- "nodeIds" : [ 1, 2 ]
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
- <a href="#Spikes">Spikes</a>
- <h4 class="field-label">400</h4>
- Operation failed due to invalid request.
- <a href="#ErrorResponse">ErrorResponse</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
- <div class="method"><a name="nestGetSpikesBySpikedetector"/>
- <div class="method-path">
- <a class="up" href="#__Methods">Up</a>
- <pre class="get"><code class="huge"><span class="http-method">get</span> /nest/spikedetectors/{spikedetectorId}/spikes</code></pre></div>
- <div class="method-summary">Retrieves the spikes for the given time range (optional) and node IDs (optional) from one spike detector. If no time range or node list is specified, it will return the spikes for whole time or all nodes respectively. (<span class="nickname">nestGetSpikesBySpikedetector</span>)</div>
- <div class="method-notes"></div>
-
- <h3 class="field-label">Path parameters</h3>
- <div class="field-items">
- <div class="param">spikedetectorId (required)</div>
-
- <div class="param-desc"><span class="param-type">Path Parameter</span> — The ID of the spike detector to query. default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
-
-
- <h3 class="field-label">Query parameters</h3>
- <div class="field-items">
- <div class="param">fromTime (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The start time in milliseconds (including) to be queried. default: null format: double</div><div class="param">toTime (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The end time in milliseconds (excluding) to be queried. default: null format: double</div><div class="param">nodeIds (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — A list of node IDs queried for spike data. default: null format: uint64</div><div class="param">skip (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The offset into the result. default: null format: uint64</div><div class="param">top (optional)</div>
-
- <div class="param-desc"><span class="param-type">Query Parameter</span> — The maximum number of entries to be returned. default: null format: uint64</div>
- </div> <!-- field-items -->
-
-
- <h3 class="field-label">Return type</h3>
- <div class="return-type">
- <a href="#Spikes">Spikes</a>
-
- </div>
-
- <!--Todo: process Response Object and its headers, schema, examples -->
-
- <h3 class="field-label">Example data</h3>
- <div class="example-data-content-type">Content-Type: application/json</div>
- <pre class="example"><code>{
- "simulationTimes" : [ 0.8, 0.9 ],
- "nodeIds" : [ 1, 2 ]
-}</code></pre>
-
- <h3 class="field-label">Produces</h3>
- This API call produces the following media types according to the <span class="header">Accept</span> request header;
- the media type will be conveyed by the <span class="header">Content-Type</span> response header.
- <ul>
- <li><code>application/json</code></li>
- </ul>
-
- <h3 class="field-label">Responses</h3>
- <h4 class="field-label">200</h4>
- Operation successful.
- <a href="#Spikes">Spikes</a>
- <h4 class="field-label">400</h4>
- Operation failed due to invalid request.
- <a href="#ErrorResponse">ErrorResponse</a>
- <h4 class="field-label">500</h4>
- Operation failed due to server error.
- <a href="#ErrorResponse">ErrorResponse</a>
- </div> <!-- method -->
- <hr/>
-
- <h2><a name="__Models">Models</a></h2>
- [ Jump to <a href="#__Methods">Methods</a> ]
-
- <h3>Table of Contents</h3>
- <ol>
- <li><a href="#Error"><code>Error</code> - </a></li>
- <li><a href="#ErrorResponse"><code>ErrorResponse</code> - </a></li>
- <li><a href="#InnerError"><code>InnerError</code> - </a></li>
- <li><a href="#MultimeterInfo"><code>MultimeterInfo</code> - </a></li>
- <li><a href="#MultimeterMeasurement"><code>MultimeterMeasurement</code> - </a></li>
- <li><a href="#NestNodeCollectionNodes"><code>NestNodeCollectionNodes</code> - </a></li>
- <li><a href="#NestNodeCollectionProperties"><code>NestNodeCollectionProperties</code> - </a></li>
- <li><a href="#NestNodeModel"><code>NestNodeModel</code> - </a></li>
- <li><a href="#NestNodeProperties"><code>NestNodeProperties</code> - </a></li>
- <li><a href="#SimulationTimeInfo"><code>SimulationTimeInfo</code> - </a></li>
- <li><a href="#SpikedetectorInfo"><code>SpikedetectorInfo</code> - </a></li>
- <li><a href="#Spikes"><code>Spikes</code> - </a></li>
- <li><a href="#Version"><code>Version</code> - </a></li>
- </ol>
-
- <div class="model">
- <h3><a name="Error"><code>Error</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">code </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> One of the error codes defined here: [...] </div>
-<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> A human-readable representation of the error. </div>
-<div class="param">innererror (optional)</div><div class="param-desc"><span class="param-type"><a href="#InnerError">InnerError</a></span> </div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="ErrorResponse"><code>ErrorResponse</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">error </div><div class="param-desc"><span class="param-type"><a href="#Error">Error</a></span> </div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="InnerError"><code>InnerError</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">code </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> One of the error codes defined here: [...] </div>
-<div class="param">innererror (optional)</div><div class="param-desc"><span class="param-type"><a href="#InnerError">InnerError</a></span> </div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="MultimeterInfo"><code>MultimeterInfo</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">multimeterId (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: uint64</div>
-<div class="param">attributes (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> </div>
-<div class="param">nodeIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">array[Integer]</a></span> format: uint64</div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="MultimeterMeasurement"><code>MultimeterMeasurement</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">simulationTimes (optional)</div><div class="param-desc"><span class="param-type"><a href="#double">array[Double]</a></span> This array is always sorted. format: double</div>
-<div class="param">nodeIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">array[Integer]</a></span> format: uint64</div>
-<div class="param">values (optional)</div><div class="param-desc"><span class="param-type"><a href="#number">array[BigDecimal]</a></span> This array contains the measured values for each node ID and time to get the value for node ID n at time t you have to use the index n * length(simulationTimes) + t </div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="NestNodeCollectionNodes"><code>NestNodeCollectionNodes</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">firstId (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: uint64</div>
-<div class="param">lastId (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: uint64</div>
-<div class="param">count (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: uint64</div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="NestNodeCollectionProperties"><code>NestNodeCollectionProperties</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">nodeCollectionId (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: uint64</div>
-<div class="param">nodes (optional)</div><div class="param-desc"><span class="param-type"><a href="#NestNodeCollectionNodes">NestNodeCollectionNodes</a></span> </div>
-<div class="param">model (optional)</div><div class="param-desc"><span class="param-type"><a href="#NestNodeModel">NestNodeModel</a></span> </div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="NestNodeModel"><code>NestNodeModel</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
-<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> </div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="NestNodeProperties"><code>NestNodeProperties</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">nodeId (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: uint64</div>
-<div class="param">nodeCollectionId (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: uint64</div>
-<div class="param">model (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
-<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#">Object</a></span> </div>
-<div class="param">position (optional)</div><div class="param-desc"><span class="param-type"><a href="#number">array[BigDecimal]</a></span> </div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="SimulationTimeInfo"><code>SimulationTimeInfo</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">stepSize (optional)</div><div class="param-desc"><span class="param-type"><a href="#double">Double</a></span> format: double</div>
-<div class="param">begin (optional)</div><div class="param-desc"><span class="param-type"><a href="#double">Double</a></span> format: double</div>
-<div class="param">end (optional)</div><div class="param-desc"><span class="param-type"><a href="#double">Double</a></span> format: double</div>
-<div class="param">current (optional)</div><div class="param-desc"><span class="param-type"><a href="#double">Double</a></span> format: double</div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="SpikedetectorInfo"><code>SpikedetectorInfo</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">spikedetectorId (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: uint64</div>
-<div class="param">nodeIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">array[Integer]</a></span> These are the nodes connected to the spike detector. format: uint64</div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="Spikes"><code>Spikes</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">simulationTimes (optional)</div><div class="param-desc"><span class="param-type"><a href="#double">array[Double]</a></span> This array is always sorted. format: double</div>
-<div class="param">nodeIds (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">array[Integer]</a></span> format: uint64</div>
- </div> <!-- field-items -->
- </div>
- <div class="model">
- <h3><a name="Version"><code>Version</code> - </a> <a class="up" href="#__Models">Up</a></h3>
- <div class='model-description'></div>
- <div class="field-items">
- <div class="param">api </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
-<div class="param">insite </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
- </div> <!-- field-items -->
- </div>
- </body>
-</html>
diff --git a/docs/getting-started.md b/docs/getting-started.md
deleted file mode 100644
index c653da498d74d785a0ac82ad27c2538f56f48a51..0000000000000000000000000000000000000000
--- a/docs/getting-started.md
+++ /dev/null
@@ -1,18 +0,0 @@
-# Getting Started
-
-## Installation
-1. For easy deployment of the pipeline we use docker containers, so make sure you have the [docker engine](https://www.docker.com) installed.
-2. Clone this repository (`git clone https://github.com/VRGroupRWTH/insite.git`).
-3. Build the containers by using the command `docker-compose build` in the root directory of the repository. On the first run, this can take quite some time. Subsequent runs will usually run much faster as docker caches intermediate builds.
-
-## Verify Installation
-1. Start the the test simulation by using the command `docker-compose up` in the root directory of the repository. To make sure the latest changes are included it is advised to use `docker-compose up --build` to avoid errors by out-of-date containers.
-2. You should now be able to query `http://localhost:8080/version` which should give an output similar to this:
- ```json
- {
- "api": "1.0",
- "insite": "1.0"
- }
- ```
- Where `insite` specifies the version of the pipeline and `api` the available endpoint versions for the REST API.
-3. You can query simulation specific queries using the `https://localhost:8080/nest/*` endpoints. E.g., `https://localhost:8080/nest/nodes` to get all nest nodes. The complete API is available [here](docs/api/README.md).