Skip to main content

ipyaladin

Documentation

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 example

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

Binder. 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.9.2-beta
0.8.1 3.9.2-beta
0.8.0 3.9.0-beta
0.7.0 3.7.3-beta
0.6.0 3.6.5
0.5.2 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

Works with

Actively tested

These are tested for each release.

Not actively tested

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.)

Release files for ipyaladin 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ipyaladin 0.8.1
File Size Uploaded
ipyaladin-0.8.1.tar.gz 30.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ipyaladin 0.8.1
File Interpreter ABI Platform
ipyaladin-0.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 59.0 kB

Release files / ipyaladin-0.8.1.tar.gz

Download URL ipyaladin-0.8.1.tar.gz
Size 30.7 kB
Tags Source
SHA-256 checksum
How to use checksums
43d7c55e8e4ec987f6045c1e1616e5b3dff6ad9fd069a586646e74f95a3fb427
BLAKE2b-256 checksum
How to use checksums
d76a2cbac851552a7044bf746db6860f639d1059b2c5d2c604fbdbb8e3f58c4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / ipyaladin-0.8.1-py3-none-any.whl

Download URL ipyaladin-0.8.1-py3-none-any.whl
Size 28.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fce2251fb50775e5e045d7e7f6c37b490dee2113c6cd2c6bdc0598290bf14118
BLAKE2b-256 checksum
How to use checksums
545b06e01a7d40c86fa9bdf6f503f1e92e599eb1ebf527027999e5594ececeea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page