Skip to main content

No project description provided

Project description

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

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

Project details


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.6.0.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

ipyaladin-0.6.0-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ipyaladin-0.6.0.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ipyaladin-0.6.0.tar.gz
Algorithm Hash digest
SHA256 db72d96407184207e54852b13319650da086f6e9a05fc94db99187be15a4ed00
MD5 da0983554b9d5600b922e6450efc7a64
BLAKE2b-256 d3adb8219e622453006e078a5a99b4f19cbb74c7aac42f5174b8ac7910455412

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ipyaladin-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 23.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ipyaladin-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f4e26e82ebfce72f18edecff6e0b7f274e150234d73d15fea372e70c8d44a453
MD5 2305881e557fcd3c1cbecb2222f369c8
BLAKE2b-256 13b8cbc9e1e799e77be801ddd53d0af4d2990841ca08f520b8dba8d097bed9ff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page