Skip to content

An IPython Widget for Aladin Lite, the sky viewer.

License

Notifications You must be signed in to change notification settings

Xen0Xys/ipyaladin

 
 

Repository files navigation

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.

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.5.1-alpha
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

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

About

An IPython Widget for Aladin Lite, the sky viewer.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 71.8%
  • JavaScript 27.8%
  • Other 0.4%