sdss_brain’s documentation

This is the documentation for the SDSS Python product sdss_brain. The current version is 0.3.0. You can install the package by doing

$ pip install sdss-brain

Or to install with extras

$ pip install sdss-brain[extras]

Contents

• Introduction to sdss_brain
  • Multi-Modal Data Access System (MMA)
  • Example Usage
  • Conveniences for the MMA
• Convenience Tools
  • Spectral Data
  • Context Managers
• Accessing unreleased ("work") data
  • Defining Work Versions
  • Version Order Precedence
  • Setting the Work Release
  • Example Access of “Work” Data
  • Work Authentication
• Connecting to Database Objects
  • Adding a Database to a Tool
  • Valid Input
  • The DatabaseHandler
  • Using the handler in a Tool
• Connecting to Remote Data Sources
  • Adding Remote Access to a Tool
  • Valid Input
  • The ApiHandler
  • Using the handler in a Tool
• Remote Data Access
  • Sending HTTP Requests with SDSSClient
  • The Api Manager
  • The Api Profile
  • Defining a new API Profile
  • Setting a global Url or API
• About the Global Config
• The Custom Config File
• How to map specific version numbers to Data Release ids
  • Creating a Mapping
  • Accessing a Mapping
  • Using a Mapping
• How to create and parse a custom objectid as valid data input
  • Overloading the _parse_input method
  • Creating an objectid regex pattern
  • Using the parse_data_input function
• Users and Authentication
  • Netrc Authentication
  • Token Authentication
  • Users

Reference

• sdss_brain Reference
• Mode Decision Tree
• Available SDSS Domains and APIs
• Change Log

Indices and tables

• Index

• Module Index