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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ipyaladin-0.8.1.tar.gz (30.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ipyaladin-0.8.1-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

Details for the file ipyaladin-0.8.1.tar.gz.

File metadata

  • Download URL: ipyaladin-0.8.1.tar.gz
  • Upload date:
  • Size: 30.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ipyaladin-0.8.1.tar.gz
Algorithm Hash digest
SHA256 43d7c55e8e4ec987f6045c1e1616e5b3dff6ad9fd069a586646e74f95a3fb427
MD5 d68821197fc0c363518d91b39693ab7d
BLAKE2b-256 d76a2cbac851552a7044bf746db6860f639d1059b2c5d2c604fbdbb8e3f58c4c

See more details on using hashes here.

File details

Details for the file ipyaladin-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: ipyaladin-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ipyaladin-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fce2251fb50775e5e045d7e7f6c37b490dee2113c6cd2c6bdc0598290bf14118
MD5 ad1e4fc7a5b90e134ad6299bb96bf915
BLAKE2b-256 545b06e01a7d40c86fa9bdf6f503f1e92e599eb1ebf527027999e5594ececeea

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

1 file

0.1.8

1 file

0.1.7

1 file

0.1.6

1 file

0.1.5

1 file

0.1.4

1 file

0.1.3

1 file

0.1.2

1 file

0.1.1

1 file

0.1.0

1 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