| Name | ipyaladin JSON |
| Version |
0.5.2
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-11-21 09:55:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD-3-Clause |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ipyaladin
[](https://cds-astro.github.io/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:
- [ipyaladin](#ipyaladin)
- [Examples](#examples)
- [A subset of examples](#a-subset-of-examples)
- [Installation](#installation)
- [Development installation](#development-installation)
- [How does it work?](#how-does-it-work)
- [Works with](#works-with)
- [Actively tested](#actively-tested)
- [Not actively tested](#not-actively-tested)
- [Acknowledging ipyaladin](#acknowledging-ipyaladin)
## Examples
Some example notebooks can be found in the [examples directory](examples).
### 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 -->
[](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.
## Installation
To install use pip or conda :
```shell
> pip install ipyaladin
```
You can already try to load ipyaladin in a notebook.
```python
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](https://nodejs.org) and [Yarn version 1](https://classic.yarnpkg.com/) are also required,
```shell
> 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](https://github.com/cds-astro/aladin-lite) into notebooks thanks to
[Anywidget](https://anywidget.dev/).
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
>
> ```python
> 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
- [JupyterLab / Jupyter Notebook](https://jupyter.org/)
- [JupyterLite](https://jupyterlite.readthedocs.io/en/stable/)
- [VSCode Jupyter](https://github.com/microsoft/vscode-jupyter)
These are tested for each release.
### Not actively tested
- [Marimo](https://marimo.io/)
- [PyCharm Notebooks](https://www.jetbrains.com/help/pycharm/jupyter-notebook-support.html)
- [Voilà / Voici](https://github.com/voila-dashboards)
- [Google Colab](https://colab.research.google.com/)
- [Panel](https://panel.holoviz.org/)
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](https://doi.org/10.26093/kpaw-kb74) ).
>
> [2020ASPC..522..117B](https://ui.adsabs.harvard.edu/abs/2020ASPC..522..117B) - ipyaladin: Enabling Aladin Lite in Jupyter Notebooks (Boch T. et al.)
Raw data
{
"_id": null,
"home_page": null,
"name": "ipyaladin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d3/fb/eb8e22ee7f474887eab359d249e11989635124804dfa2aa696fbc980c3b9/ipyaladin-0.5.2.tar.gz",
"platform": null,
"description": "# ipyaladin\n\n[](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\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<!-- Examples -->\n<table><tbody>\n<tr>\n <td align=\"center\">basic commands</td>\n <td align=\"center\">importing tables</td>\n <td align=\"center\">display MOCs</td></tr><tr>\n <td align=\"center\"><a href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/02_Base_Commands.html\">\n <img height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/02.png\"></img></a></td>\n <td align=\"center\"><a href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/04_Importing_Tables.html\">\n <img height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/04.png\"></img></a></td>\n <td align=\"center\"><a href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/05_Display_a_MOC.html\">\n <img height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/05.png\"></img></a></td></tr><tr>\n <td align=\"center\">display sky regions</td>\n <td align=\"center\">retrieve data from the widget</td>\n <td align=\"center\">advanced app</td></tr><tr>\n <td align=\"center\"><a href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/09_Displaying_Shapes.html\">\n <img height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/09.png\"></img></a></td>\n <td align=\"center\"><a href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/11_Extracting_information_from_the_view.html\">\n <img height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/11.png\"></img></a></td>\n <td align=\"center\"><a href=\"https://cds-astro.github.io/ipyaladin/_collections/notebooks/10_Advanced-GUI.html\">\n <img height=\"125\" src=\"https://cds-astro.github.io/ipyaladin/_static/notebooks_thumbnails/10.png\"></img></a></td></tr>\n</tbody></table>\n<!-- Examples -->\n\n[](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> 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> git clone https://github.com/cds-astro/ipyaladin.git\n> cd ipyaladin\n> npm install\n> 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.5.1-beta |\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> [!TIP]\n> This can always be read like so\n>\n> ```python\n> from ipyaladin import __version__, __aladin_lite_version__\n> print(\"version:\", __version__, \"running Aladin Lite:\", __aladin_lite_version__)\n> ```\n>\n> ```\n> version: 0.4.0 running Aladin Lite: 3.4.4-beta\n> ```\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\u00e0 / 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> 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>\n> [2020ASPC..522..117B](https://ui.adsabs.harvard.edu/abs/2020ASPC..522..117B) - ipyaladin: Enabling Aladin Lite in Jupyter Notebooks (Boch T. et al.)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": null,
"version": "0.5.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "48ae48efb0ddac2a56ab3205f2349991662143b4c9336f6e39bf204672b9b325",
"md5": "6b8026a2ee6cacb401e6f3cbf3046a3a",
"sha256": "8cb90e1e6fdb5c58602e0d53c1b99e9f0a9a0abc863dfe35c58aeeace7701394"
},
"downloads": -1,
"filename": "ipyaladin-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b8026a2ee6cacb401e6f3cbf3046a3a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21258,
"upload_time": "2024-11-21T09:55:04",
"upload_time_iso_8601": "2024-11-21T09:55:04.047856Z",
"url": "https://files.pythonhosted.org/packages/48/ae/48efb0ddac2a56ab3205f2349991662143b4c9336f6e39bf204672b9b325/ipyaladin-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3fbeb8e22ee7f474887eab359d249e11989635124804dfa2aa696fbc980c3b9",
"md5": "e613a8d7734fb742f8f9d413584deb91",
"sha256": "eee74cb71bb6ff3b20f5dbf323bcbbaf69bf0b7c352bf523d29dc4533e6393a8"
},
"downloads": -1,
"filename": "ipyaladin-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "e613a8d7734fb742f8f9d413584deb91",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20703,
"upload_time": "2024-11-21T09:55:05",
"upload_time_iso_8601": "2024-11-21T09:55:05.447161Z",
"url": "https://files.pythonhosted.org/packages/d3/fb/eb8e22ee7f474887eab359d249e11989635124804dfa2aa696fbc980c3b9/ipyaladin-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 09:55:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ipyaladin"
}
