Skip to content

Commit

Permalink
fix old links to the API documentation, and replace mentions of Djang…
Browse files Browse the repository at this point in the history
…o with FastAPI
  • Loading branch information
apdavison committed Mar 1, 2024
1 parent e819c32 commit 1e225f6
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ https://neo-viewer.brainsimulation.eu/

## Quick overview

The component was developed to produce graphical representations of neural activity data based on the Neo object model. [Neo](http://neuralensemble.org/neo) is an open source API implemented in Python supporting many file formats, including several proprietary formats (e.g. AlphaOmega, Plexon, NeuroExplorer), open formats (e.g. Neurodata Without Borders, Klustakwik, Elan) and generic file formats (e.g. MATLAB, ASCII, HDF5). Neo loads this data into a common object model with the aim of increasing interoperability of various software tools used in electrophysiology and thus facilitating sharing of data between different projects. Neo's focus is solely on the structure of the data, with separate tools being required for their analysis. Our compoment comes in at this stage by enabling interactive visualization of data. It makes use of the open source [Plotly](https://plotly.com/javascript/) library for visualisation, owing to its efficiency in handling large data, and [Django](https://www.djangoproject.com/) Python web framework for the backend.
The component was developed to produce graphical representations of neural activity data based on the Neo object model. [Neo](http://neuralensemble.org/neo) is an open source API implemented in Python supporting many file formats, including several proprietary formats (e.g. AlphaOmega, Plexon, NeuroExplorer), open formats (e.g. Neurodata Without Borders, Klustakwik, Elan) and generic file formats (e.g. MATLAB, ASCII, HDF5). Neo loads this data into a common object model with the aim of increasing interoperability of various software tools used in electrophysiology and thus facilitating sharing of data between different projects. Neo's focus is solely on the structure of the data, with separate tools being required for their analysis. Our compoment comes in at this stage by enabling interactive visualization of data. It makes use of the open source [Plotly](https://plotly.com/javascript/) library for visualisation, owing to its efficiency in handling large data, and [FastAPI](https://fastapi.tiangolo.com) Python web framework for the backend.


## AngularJS (v1) component
Expand Down
2 changes: 1 addition & 1 deletion api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ It is implemented with [FastAPI](https://fastapi.tiangolo.com/).

## API Documentation

See [here](https://neo-viewer.brainsimulation.eu/api-docs).
See [here](https://neo-viewer.brainsimulation.eu/api/docs).

## Deployment

Expand Down
2 changes: 1 addition & 1 deletion homepage/angularjs_demo.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ <h5 style="text-align: center; line-height: 2; font-weight: bolder;">AngularJS C
<div class="text" style="margin: 15px 35px 15px 35px;">
The neural-activity-visualizer Javascript app, enables web-browser
visualisation of electrophysiology datafiles in any format supported by the Neo library. It makes use of
the <a href="/api-docs" target="_blank"
the <a href="/api/docs" target="_blank"
rel="noopener noreferrer">Neo Viewer
REST API</a>.
<br>
Expand Down
2 changes: 1 addition & 1 deletion homepage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ <h5 style="text-align: center; line-height: 2; font-weight: bolder;">Quick Overv
<a href="https://plotly.com/javascript/" target="_blank" rel="noopener noreferrer">Plotly</a>
library
for visualisation, owing to its efficiency in handling large data, and
<a href="https://www.djangoproject.com/" target="_blank" rel="noopener noreferrer">Django</a>
<a href="https://fastapi.tiangolo.com" target="_blank" rel="noopener noreferrer">FastAPI</a>
Python web framework for the backend.
</div>
<hr style="color: #CCCCCC">
Expand Down
2 changes: 1 addition & 1 deletion js/angularjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Instructions for doing this are [here](https://github.com/NeuralEnsemble/neo-vie

## Reference: the file server REST API

See [here](https://neo-viewer.brainsimulation.eu/#api-docs).
See [here](https://neo-viewer.brainsimulation.eu/api/docs).


<div><img src="../../eu_logo.jpg" alt="EU Logo" width="15%" align="right"></div>
Expand Down
2 changes: 1 addition & 1 deletion js/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Instructions for doing this are [here](https://github.com/NeuralEnsemble/neo-vie

## Reference: the file server REST API

See [here](https://neo-viewer.brainsimulation.eu/#api-docs).
See [here](https://neo-viewer.brainsimulation.eu/api/docs).


<div><img src="../../eu_logo.jpg" alt="EU Logo" width="15%" align="right"></div>
Expand Down
2 changes: 1 addition & 1 deletion js/react/demo/src/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ function App() {
web-browser visualisation of electrophysiology datafiles in any
format supported by the Neo library. It makes use of the{" "}
<a
href="/api-docs"
href="/api/docs"
target="_blank"
rel="noopener noreferrer"
>
Expand Down

0 comments on commit 1e225f6

Please sign in to comment.