Skip to content
Snippets Groups Projects
Commit 9db762bf authored by Marcel Krüger's avatar Marcel Krüger
Browse files

docs: clean up

parent bda073e2
No related branches found
No related tags found
No related merge requests found
Pipeline #251340 canceled
Stage: test
Expand all Show whitespace changes
Inline Side-by-side
docs/access-node-api.md deleted 100644 → 0
+ 0
− 413
View file @ bda073e2
# 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
docs/api/index.md deleted 100644 → 0
+ 0
− 2
View file @ bda073e2
# Insite API Specification
* [Version 1](v1/index.html)
docs/api/v1/index.html deleted 100644 → 0
+ 0
− 1297
View file @ bda073e2
This diff is collapsed.
docs/getting-started.md deleted 100644 → 0
+ 0
− 18
View file @ bda073e2
# 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).
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment