{"id":17526828,"url":"https://github.com/cds-astro/ipyaladin","last_synced_at":"2025-12-29T23:37:16.693Z","repository":{"id":60722464,"uuid":"95673101","full_name":"cds-astro/ipyaladin","owner":"cds-astro","description":"An IPython Widget for Aladin Lite, the sky viewer.","archived":false,"fork":false,"pushed_at":"2024-09-30T16:03:22.000Z","size":45237,"stargazers_count":124,"open_issues_count":13,"forks_count":26,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-09-30T16:55:00.666Z","etag":null,"topics":["aladin","astronomy","astrophysics","ipywidgets","jupyterlab-extension","python","visualization"],"latest_commit_sha":null,"homepage":"https://cds-astro.github.io/ipyaladin/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cds-astro.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-28T13:40:27.000Z","updated_at":"2024-09-30T15:59:11.000Z","dependencies_parsed_at":"2024-03-15T11:51:17.190Z","dependency_job_id":"30dd7946-c4b5-45e1-85a7-0fe896a3962b","html_url":"https://github.com/cds-astro/ipyaladin","commit_stats":{"total_commits":128,"total_committers":8,"mean_commits":16.0,"dds":0.703125,"last_synced_commit":"1398839ae4645d0eb86bf7482fd12782a6efef6e"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cds-astro%2Fipyaladin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cds-astro%2Fipyaladin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cds-astro%2Fipyaladin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cds-astro%2Fipyaladin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cds-astro","download_url":"https://codeload.github.com/cds-astro/ipyaladin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242161421,"owners_count":20081867,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aladin","astronomy","astrophysics","ipywidgets","jupyterlab-extension","python","visualization"],"created_at":"2024-10-20T15:02:33.177Z","updated_at":"2025-12-29T23:37:16.687Z","avatar_url":"https://github.com/cds-astro.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# ipyaladin\n\n[![Documentation](https://img.shields.io/badge/Documentation-gray?style=flat\u0026link=https://cds-astro.github.io/ipyaladin/)](https://cds-astro.github.io/ipyaladin/)\n\nA bridge between Jupyter and Aladin Lite, enabling interactive sky visualization in IPython notebooks.\nWith a couple of lines, you can display Aladin Lite, center it on the target of your choice, and overlay an Astropy table:\n\n![ipyaladin example](assets/ipyaladin-screencast.gif)\n\n- [ipyaladin](#ipyaladin)\n  - [Examples](#examples)\n    - [A subset of examples](#a-subset-of-examples)\n  - [Installation](#installation)\n  - [Development installation](#development-installation)\n  - [How does it work?](#how-does-it-work)\n  - [Works with](#works-with)\n    - [Actively tested](#actively-tested)\n    - [Not actively tested](#not-actively-tested)\n  - [Acknowledging ipyaladin](#acknowledging-ipyaladin)\n\n## Examples\n\nSome example notebooks can be found in the [examples directory](examples).\n\n### A subset of examples\n\n\u003c!-- Examples --\u003e\n\u003ctable\u003e\u003ctbody\u003e\n\u003ctr\u003e\n  \u003ctd align=\"center\"\u003ebasic commands\u003c/td\u003e\n  \u003ctd align=\"center\"\u003eimporting tables\u003c/td\u003e\n  \u003ctd align=\"center\"\u003edisplay MOCs\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/02_Base_Commands.html\"\u003e\n      \u003cimg height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/02.png\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/04_Importing_Tables.html\"\u003e\n      \u003cimg height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/04.png\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/05_Display_a_MOC.html\"\u003e\n      \u003cimg height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/05.png\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\n  \u003ctd align=\"center\"\u003edisplay sky regions\u003c/td\u003e\n  \u003ctd align=\"center\"\u003eretrieve data from the widget\u003c/td\u003e\n  \u003ctd align=\"center\"\u003eadvanced app\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/09_Displaying_Shapes.html\"\u003e\n      \u003cimg height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/09.png\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/11_Extracting_information_from_the_view.html\"\u003e\n      \u003cimg height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/11.png\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/10_Advanced-GUI.html\"\u003e\n      \u003cimg height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/10.png\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\n\u003c/tbody\u003e\u003c/table\u003e\n\u003c!-- Examples --\u003e\n\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/cds-astro/ipyaladin/master). You can also try it directly [in mybinder](https://mybinder.org/v2/gh/cds-astro/ipyaladin/master), without installing anything.\n\n## Installation\n\nTo install use pip or conda :\n\n```shell\n\u003e pip install ipyaladin\n```\n\nYou can already try to load ipyaladin in a notebook.\n\n```python\nfrom ipyaladin import Aladin\naladin = Aladin()\naladin\n```\n\n## Development installation\n\nFirst, make sure you have installed jupyter in your python environnement: `pip install jupyter`.\nFor a development installation [Node.js](https://nodejs.org) and [Yarn version 1](https://classic.yarnpkg.com/) are also required,\n\n```shell\n\u003e git clone https://github.com/cds-astro/ipyaladin.git\n\u003e cd ipyaladin\n\u003e npm install\n\u003e npm run dev\n```\n\nAnd you are ready to develop! Any change done in the python, javascript, or css files should\nbe directly reflected in the notebook editor of your choice (JupyterLab, VSCode,...)!\n\n## How does it work?\n\nIpyaladin brings [Aladin Lite](https://github.com/cds-astro/aladin-lite) into notebooks thanks to\n[Anywidget](https://anywidget.dev/).\n\nCorrespondence table between ipyaladin versions and Aladin Lite versions:\n\n| ipyaladin  | Aladin-Lite |\n| ---------- | ----------- |\n| Unreleased | 3.7.3-beta  |\n| 0.7.0      | 3.7.3-beta  |\n| 0.6.0      | 3.6.5       |\n| 0.5.2      | 3.5.1-beta  |\n| 0.5.1      | 3.5.1-beta  |\n| 0.5.0      | 3.5.1-beta  |\n| 0.4.0      | 3.4.4-beta  |\n| 0.3.0      | 3.3.3-dev   |\n\n\u003e [!TIP]\n\u003e This can always be read like so\n\u003e\n\u003e ```python\n\u003e from ipyaladin import __version__, __aladin_lite_version__\n\u003e print(\"version:\", __version__, \"running Aladin Lite:\", __aladin_lite_version__)\n\u003e ```\n\u003e\n\u003e ```\n\u003e version: 0.4.0 running Aladin Lite: 3.4.4-beta\n\u003e ```\n\n## Works with\n\n### Actively tested\n\n- [JupyterLab / Jupyter Notebook](https://jupyter.org/)\n- [JupyterLite](https://jupyterlite.readthedocs.io/en/stable/)\n- [VSCode Jupyter](https://github.com/microsoft/vscode-jupyter)\n\nThese are tested for each release.\n\n### Not actively tested\n\n- [Marimo](https://marimo.io/)\n- [PyCharm Notebooks](https://www.jetbrains.com/help/pycharm/jupyter-notebook-support.html)\n- [Voilà / Voici](https://github.com/voila-dashboards)\n- [Google Colab](https://colab.research.google.com/)\n- [Panel](https://panel.holoviz.org/)\n\nWe 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.\n\n## Acknowledging ipyaladin\n\nIf you use `ipyaladin` for your work or research, we kindly ask you to cite it with the following acknowledgment:\n\n\u003e This research made use of ipyaladin, developed by CDS, Strasbourg Astronomical Observatory, France (DOI: [10.26093/kpaw-kb74](https://doi.org/10.26093/kpaw-kb74) ).\n\u003e\n\u003e [2020ASPC..522..117B](https://ui.adsabs.harvard.edu/abs/2020ASPC..522..117B) - ipyaladin: Enabling Aladin Lite in Jupyter Notebooks (Boch T. et al.)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcds-astro%2Fipyaladin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcds-astro%2Fipyaladin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcds-astro%2Fipyaladin/lists"}