ipyaladin 0.5.1

No project description provided

ipyaladin

A bridge between Jupyter and Aladin Lite, enabling interactive sky visualization in IPython notebooks. With a couple of lines, you can display Aladin Lite, center it on the target of your choice, and overlay an Astropy table:

• ipyaladin
  • Examples
    • A subset of examples
  • Installation
  • Development installation
  • How does it work?
  • Works with
    • Actively tested
    • Not actively tested
  • Acknowledging ipyaladin

Examples

Some example notebooks can be found in the examples directory.

A subset of examples

basic commands	importing tables	display MOCs
display sky regions	retrieve data from the widget	advanced app

. You can also try it directly in mybinder, without installing anything.

Installation

To install use pip or conda :

> pip install ipyaladin

You can already try to load ipyaladin in a notebook.

from ipyaladin import Aladin
aladin = Aladin()
aladin

Development installation

First, make sure you have installed jupyter in your python environnement: pip install jupyter. For a development installation Node.js and Yarn version 1 are also required,

> git clone https://github.com/cds-astro/ipyaladin.git
> cd ipyaladin
> npm install
> npm run dev

And you are ready to develop! Any change done in the python, javascript, or css files should be directly reflected in the notebook editor of your choice (JupyterLab, VSCode,...)!

How does it work?

Ipyaladin brings Aladin Lite into notebooks thanks to Anywidget.

Correspondence table between ipyaladin versions and Aladin Lite versions:

ipyaladin	Aladin-Lite
Unreleased	3.5.1-beta
0.5.1	3.5.1-beta
0.5.0	3.5.1-beta
0.4.0	3.4.4-beta
0.3.0	3.3.3-dev

[!TIP] This can always be read like so

from ipyaladin import __version__, __aladin_lite_version__
print("version:", __version__, "running Aladin Lite:", __aladin_lite_version__)

version: 0.4.0 running Aladin Lite: 3.4.4-beta

Works with

Actively tested

• JupyterLab / Jupyter Notebook
• JupyterLite
• VSCode Jupyter

These are tested for each release.

Not actively tested

• Marimo
• PyCharm Notebooks
• Voilà / Voici
• Google Colab
• Panel

We know that it works, but we don't track the bugs ourselves. Feel free to open an issue if something is not working anymore. You can also contribute to this list if you know of an other notebook environment where ipyaladin works.

Acknowledging ipyaladin

If you use ipyaladin for your work or research, we kindly ask you to cite it with the following acknowledgment:

This research made use of ipyaladin, developed by CDS, Strasbourg Astronomical Observatory, France (DOI: 10.26093/kpaw-kb74 ).

2020ASPC..522..117B - ipyaladin: Enabling Aladin Lite in Jupyter Notebooks (Boch T. et al.)