Awesome
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:
Examples
Some example notebooks can be found in the examples directory.
A subset of examples
<!-- Examples --> <table><tbody> <tr> <td align="center">basic commands</td> <td align="center">importing tables</td> <td align="center">display MOCs</td></tr><tr> <td align="center"><a href="https://cds-astro.github.io/ipyaladin/_collections/notebooks/02_Base_Commands.html"> <img height="125" src="https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/02.png"></img></a></td> <td align="center"><a href="https://cds-astro.github.io/ipyaladin/_collections/notebooks/04_Importing_Tables.html"> <img height="125" src="https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/04.png"></img></a></td> <td align="center"><a href="https://cds-astro.github.io/ipyaladin/_collections/notebooks/05_Display_a_MOC.html"> <img height="125" src="https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/05.png"></img></a></td></tr><tr> <td align="center">display sky regions</td> <td align="center">retrieve data from the widget</td> <td align="center">advanced app</td></tr><tr> <td align="center"><a href="https://cds-astro.github.io/ipyaladin/_collections/notebooks/09_Displaying_Shapes.html"> <img height="125" src="https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/09.png"></img></a></td> <td align="center"><a href="https://cds-astro.github.io/ipyaladin/_collections/notebooks/11_Extracting_information_from_the_view.html"> <img height="125" src="https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/11.png"></img></a></td> <td align="center"><a href="https://cds-astro.github.io/ipyaladin/_collections/notebooks/10_Advanced-GUI.html"> <img height="125" src="https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/10.png"></img></a></td></tr> </tbody></table> <!-- Examples -->
. 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.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 |
[!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
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.)