Skip to main content
Ctrl+K
Logo image Logo image

Rubin Science Platform

Site Navigation

  • Guides
  • Support
  • Roadmap
  • Contributing
  • Updates
  • Rubin docs

Site Navigation

  • Guides
  • Support
  • Roadmap
  • Contributing
  • Updates
  • Rubin docs

Section Navigation

Getting Started

  • Get started on the Rubin Science Platform
    • Getting an account on the RSP
    • Linking additional identities
    • First steps with the Portal
    • First steps with the Notebooks

Accounts

  • Authentication
    • Creating user tokens
    • Token scopes
    • Tutorial: Authenticating from TOPCat outside the Science Platform

Aspects

  • Portal
    • Start and stop a session
    • Using the Portal
      • Portal tutorials
  • Notebooks
    • Start and stop a server
    • Using Jupyter Notebooks
      • Tutorial Notebooks
    • Using the JupyterLab terminal
    • Using the Science Pipelines
      • Using the LSST Science Pipelines in the terminal
      • Using the LSST Science Pipelines in notebooks (LSST kernel)
      • Developing LSST Science Pipelines packages in the Notebook Aspect
    • Configuring the Notebook Aspect
      • Configuring Git for GitHub
      • Configuring your shell
      • Configure the shell environment for notebook kernels
      • Install packages in user environment
      • User-managed groups
      • Customizing user interface appearance
    • Frequently Asked Questions
  • API

Applications

  • Times Square
    • Authoring notebooks
      • Making a notebook compatible with Times Square
      • How to write a notebook for Times Square
      • Parameter types
      • Sidecar metadata YAML file reference
    • Managing GitHub repositories
      • How to set up and install a GitHub repository into Times Square
      • Setting up pre-commit hooks to format notebooks
      • How to add GitHub branch protections to a Times Square repository
      • times-square.yaml schema reference

Authoring notebooks¶

If you know the basics of Jupyter notebooks and GitHub, you can add notebooks to Times Square. This section helps you understand how to write notebooks for Times Square, including how to parameterize notebooks so that users can execute notebooks with different inputs.

Overviews

  • Making a notebook compatible with Times Square

How to guides

  • How to write a notebook for Times Square

Reference

  • Parameter types
  • Sidecar metadata YAML file reference

previous

Times Square

next

Making a notebook compatible with Times Square

Edit this page

© Copyright 2018–2025 Association of Universities for Research in Astronomy, Inc. (AURA).

Built with the PyData Sphinx Theme 0.12.0.

Created using Sphinx 8.1.3.