Skip to content

Neuroscale Overview

Welcome to the NeuroScale documentation! This page gives a brief intro to the NeuroScale service, followed by an overview of the documentation.

What is NeuroScale?

NeuroScale is a platform that runs neural/bio-signal processing pipelines, allowing you to process high-bandwidth sensor data, such as EEG, NIRS or other brain signals along with many other sensor modalities, in the cloud.

NeuroScale comprises two related services:

  • NeuroScale Insights allows you to analyze brain data along with other modalities from various kinds of standard file formats in a batch-processing fashion, and automatically generates comprehensive interactive visual reports along with statistical analyses, standard plots, and quality assessments, and outputs results that you can further process in your scientific or product workflow. Get started with our tutorials.

  • NeuroScale Streaming allows you to process data streams from multiple sensors in real time and can generate for you, for instance, real-time estimates of various kinds of user states, brain images, or simply processed and cleaned-up forms of different kinds of sensor signals. You can stream data to and from NeuroScale from anywhere in the world with just an internet connection.

It doesn't matter whether you're an academic who wants to accelerate their scientific research or who experiments with real-time brain-computer interfaces, or a startup working on a product that involves any kind of neuro assessments in real time and/or following a user session, or a large enterprise engaged in user studies, workplace optimization, product development, or whatever it is you do with brain/bio sensor data -- NeuroScale quite likely has components that can serve your needs.

NeuroScale workflows are oriented around processing pipelines, which are either run in batch mode on files in your cloud data storage, or in real time on streaming data. NeuroScale provides a number of pipelines out of the box, most of which expose a variety of parameters that you can fine-tune to your needs, and we add new pipelines all the time. If you are looking for a specific pipeline, let us know -- we may already have it and could make it available to you. Using our NeuroPype Enterprise Suite, you can also design your own pipelines in an easy-to-use visual programming environment, run them locally on your machine, and once tested upload them to your NeuroScale account in order to run them at scale and to access them from anywhere in the world.

Most of your interactions with NeuroScale will be either via the NeuroScale Dashboard from where you can initiate most tasks, or via our comprehensive REST API. The API will be most useful once you are ready to use NeuroScale as part of a product, or simply if you are a workflow automation fan.

Your NeuroScale account comes with your own private storage folder that your pipelines can use, and you can copy files to and from it either via the dashboard, or a number of desktop clients, or using the API; alternatively you can also bring your own storage (e.g., a bucket or folder on Amazon S3) and give pipelines read or write access to data in it.

Overview

This part of the documentation, which you are reading now, introduces you to basic concepts in NeuroScale and provides useful foundation for the rest of the documentation, which can help you get a better understanding of the service. However, if you're in a hurry, skip right ahead to the user guides.

User Guides

This group of articles will get you up and running quickly with descriptions on how to perform a number of key NeuroScale tasks with the NeuroScale User Dashboard. One does not need to be a developer or overly technical to understand and work through these. We do recommend going through the guides in order, as they build on each other. For example, a streaming pipeline must be created before it can be managed. If you get stuck and need extra help, consult the Overview or FAQ, Tips and Tricks sections, and the preceding guides. Going through these guides will provide you with a solid command of using NeuroScale from a non-developer perspective.

Get started here!

Developer API Tutorials

These articles introduce you to how you perform a number of key tasks through the REST API, allowing you to easily integrate NeuroScale's capabilities with your own products, whether these are backend services, mobile apps, or enterprise products. These examples are designed to get you up and running quickly. Depending on whether you need streaming or batch processing, only a part of these articles will be relevant to you.

The NeuroScale API

These articles discuss in more detail how to interact with the NeuroScale API using cURL, Python, JavaScript, C# or Java(Android) and will help you get your environment setup properly and guide you through a number of helpful examples.

Advanced Developer Topics

Further details on advanced NeuroScale topics are provided in this section. If you are in need of more information on Neuroscale's system design, instance architecture, messaging protocol, etc., this is the place to look. If the information you are searching for is not in this section and you have combed through the rest of the documentation, please contact us via email at support@neuroscale.io.

FAQ, Tips & Tricks

This section is not necessary for getting started with NeuroScale, but you may find the answer you seek or generally useful topics of interest in there. Be aware that NeuroScale covers a number of diverse use cases, so only a subset of this content will apply to you.

Reference Documentation

The full reference documentation for NeuroScale's REST API can be found in the API Reference. Go here for the full details on each API. Also, if you're a developer, the API Reference offers some power-user functions not covered in the tutorials, so feel free to look around.

Developer Resources

As a NeuroScale developer, you are not just getting access to the API documentation, but a host of other resources. This includes access to a GitHub repository with additional sample code, utilities, and datasets (visible to you if you are logged in to GitHub and have provided us with your GitHub username), access to the NeuroScale dashboard, and support at developer_support@neuroscale.io. Have a look at the Resources Overview page for details.