The ipyaladin jupyter widget

Ipyaladin brings Aladin-Lite into Jupyter.

User Guide

Information about installing and using this widget.

• Getting Started
  • Installation
    • Released versions
    • Unreleased version
  • Using the widget
    • Getting Started

Contribution guide

In this part, we detail how ipyaladin works and how to contribute to the project.

• Community
  • Contributions
  • Development installation
  • Git hooks
  • Development branch
  • Running the tests
    • Python tests
    • Javascript tests
    • Check that the documentation still builds
    • Adding a changelog entry
  • How does it work

User Documentation

Examples that illustrate how ipyaladin can be used.

• User Documentation
  • Initialization options for the widget
  • Setting the view’s parameters
    • Aladin commands
    • Use of functions on ipyaladin widgets
      • Home-made functions
      • Built-in methods
    • Planetary surveys
      • Surveys of Earth
  • Adding elements to the widget
    • Adding tables to the view
      • Table from a database
      • Displaying a QTable
    • Display of a Multi Order Coverage (MOC)
      • From an URL
      • From a dictionnary
      • From a mocpy object
    • Adding shapes / graphic overlays
      • Add shapes from Space-Time Coordinates (STC)
      • Add shapes from astropy-regions objects
  • Retrieving information from the current widget view
    • Retrieving data from the current widget’s view
      • Getting the current WCS
      • Getting the field of view
      • Getting the selection
      • Getting the view as a fits file
      • Saving the view as an image file
    • Note about the WCS
      • 1. Detaching the widget from the notebook and keeping it on the side of the notebook
      • 2. Disabling the optimization in the notebook parameters
  • Advanced use
    • Linked widgets
    • On click callback
    • Example of interactive rectangular selection
    • Advanced GUI

API

The content of the exposed ipyaladin API.

• API
  • ipyaladin
    • Submodules
      • ipyaladin.widget