pyNS: Neuroscout API client documentation
pyNS is the Python client for the Neuroscout API, allowing users to programmatically query and interactive with the Neuroscout database. This allows users to create analyses, query for analyses, and download analysis results.
pyNS provides a number of high-level functions for common tasks (that would typically require multiple API calls), such as creating and registering analyses, and fetching predictor and imaging data directly.
Advanced use cases include: batch-creation of analyses (e.g. for meta-analysis) and the creation of custom analysis pipelines.
pyNS mirrors the official Neuroscout API with a Pythonic interface. Note that the best reference for the API is the official API docs
See the Installation and Quickstart sections to get started.
Note
If you’re just starting out with Neuroscout, take a look at the main website (https://neuroscout.org), and the accompanying documentation.
Contents
- Installation
- Quickstart
- Querying the Neuroscout API
- Creating analyses
- Fetching predictors & images
- API
- pyns.api
- pyns.endpoints
- pyns.endpoints.analysis
- pyns.endpoints.analysis.Analyses
AnalysesAnalyses.__init__()Analyses.clone()Analyses.compile()Analyses.create_analysis()Analyses.delete()Analyses.fill()Analyses.generate_report()Analyses.get_analysis()Analyses.get_bundle()Analyses.get_design_matrix()Analyses.get_full()Analyses.get_report()Analyses.get_resources()Analyses.get_status()Analyses.get_uploads()Analyses.load_uploads()Analyses.plot_report()Analyses.plot_uploads()Analyses.put()Analyses.upload_neurovault()
- pyns.endpoints.analysis.Analysis
- pyns.endpoints.analysis.Analyses
- pyns.endpoints.base
- pyns.endpoints.dataset
- pyns.endpoints.predictor
- pyns.endpoints.user
- pyns.endpoints.utils
- pyns.endpoints.analysis
- pyns.fetch_utils