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
- 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 .
- Update
~/nsgrest.confwith 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
- Try listing your jobs
nsgr_job -l
- 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.
Metadata
Release files for pynsgr 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pynsgr-1.0.3.tar.gz | 17.2 kB | Without provenance | Details for pynsgr-1.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pynsgr-1.0.3-py3-none-any.whl | Python 3 | none | any | Details for pynsgr-1.0.3-py3-none-any.whl |
Total release size: 35.1 kB
Release files / pynsgr-1.0.3.tar.gz
| Download URL | pynsgr-1.0.3.tar.gz |
|---|---|
| Size | 17.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7a729e41407aae0ff9185b0ee420ed1aae2fbd5f5ff77523d37f41a48c252d09
|
|
BLAKE2b-256 checksum How to use checksums |
43f1f17ce5a8b530e32ef3af2732f0caa4d17b4136c75664bc04c4bbeaeaf786
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / pynsgr-1.0.3-py3-none-any.whl
| Download URL | pynsgr-1.0.3-py3-none-any.whl |
|---|---|
| Size | 18.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3553116b08c63bf3205a0f7d55068386a636b82b9df2089675c46d0d1a0fd809
|
|
BLAKE2b-256 checksum How to use checksums |
69f273a752fcb8e44cbc2337a6b963f54d54444f75602d48dba95f06317fabd7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Security for pynsgr 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.