eegkit / pynsgr

Python interface to the NeuroScience Gateway REST interface, based on pycipres

pynsgr

Python interface to the NeuroScience Gateway REST interface, based on the previously developed pycipres.

Quick start guide

Creating an account on NSGR

Please head to the NSGR web portal to create an account. Documentation there includes the list of available tools and other information. A tutorial is available, and so is a complete user guide.

Once you have created an account, you must create a new "application" to be able to use the REST API:

• login, click "Developer" > "Application management"
• click "create new application"
• fill in the form: please use the "DIRECT" authentication type

This will create the application for you and create an application ID for you to use (see below).

Using this package

1. Install this package directly using pip:

pip install pynsgr

or from source (to get the latest development version, for example):

git clone https://github.com/OpenSourceBrain/pynsgr
cd pynsgr
pip install .

2. Update ~/nsgrest.conf with your account and application information:

URL=https://nsgr.sdsc.edu:8443/cipresrest/v1
USERNAME=<YOUR_USERNAME>
PASSWORD=<YOUR_PASSWORD>
APPID=<YOUR_APPID>
APPNAME=PY_EXPANSE

3. Try listing your jobs

nsgr_job -l

4. Submit a job

nsgr_submit <directory> validate
nsgr_submit <directory> run

For more information on what the tools do, use the -h option:

nsgr_submit -h
nsgr_job -h

where <directory> contains the zipped code to run, and the two properties files. See the example folder for an example of this and configuration files that are used.