Usage & Reference#

Documentation Status PyPI version

pyNS is the Python client library for accessing the Neuroscout API.

At it’s most basic, pyNS facilitates making HTTP requests to the API, by pre-formulating requests, and making it accessible via an easy-to-use, Pythonic API. In addition, pyNS supports Neuroscout applications that interact with the API, such as Neuroscout-CLI.

For the end user, pyNS enables flexibly querying and interaction with the Neuroscout API, enabling several advanced cases not supports by the web-based application such as:

  • Downloading data from Neuroscout, including full predictor time courses

  • Batch-creation of analyses– particular useful for meta-analytic workflows which test the same analysis across datasets

  • Full flexiblity in specification of BIDS StatsModels. This enables statistical models which may not be supported by the web app, but are valid and executable models.

In addition, for developers pyNS may enable the development of novel experimental applications that use Neuroscout API’s data. For example, there is ongoing work to develop an encoding analysis workflow in Neuroscout using pyNS.

Quickstart#

For comprehensive reference of pyNS usage (including quickstart, querying & creating analyses) and Python API reference, please visit the official pyNS Documentation on ReadTheDocs. These docs are updated as new pyNS versions are released.

Contribute to pyNS#

If you’d like to conribute to pyNS, visit the pyNS repository on GitHub. For bug reports or feature requests, please submit an issue.