ipyaladin


Nameipyaladin JSON
Version 0.3.0 PyPI version JSON
download
home_page
Summary
upload_time2024-03-15 14:27:28
maintainer
docs_urlNone
author
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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 example](assets/ipyaladin-screencast.gif)

- [ipyaladin](#ipyaladin)
  - [Examples](#examples)
  - [Installation](#installation)
  - [Development installation](#development-installation)
  - [How does it work?](#how-does-it-work)

## Examples

Some example notebooks can be found in the [examples directory](examples).

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

## Installation

To install use pip or conda :

```shell
> pip install ipyaladin
> # OR
> conda install -c bmatthieu3 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 |
| --------- | ----------- |
| 0.3.0     | 3.3.3-dev   |

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ipyaladin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "",
    "download_url": "",
    "platform": null,
    "description": "# 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  - [Installation](#installation)\n  - [Development installation](#development-installation)\n  - [How does it work?](#how-does-it-work)\n\n## Examples\n\nSome example notebooks can be found in the [examples directory](examples).\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> pip install ipyaladin\n> # OR\n> conda install -c bmatthieu3 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| 0.3.0     | 3.3.3-dev   |\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "",
    "version": "0.3.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5b8ed48d5b3f77e40d09c12933c23c6951624d919f4400ddb8ae29f4f9d700db",
                "md5": "2b8c6bdc20210c0cbf98d1a66f131bdf",
                "sha256": "56ba01d34106a688e826e6f889c7d12e47d327d7d4fdedfd16eb59d352cc17ab"
            },
            "downloads": -1,
            "filename": "ipyaladin-0.3.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2b8c6bdc20210c0cbf98d1a66f131bdf",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 7748,
            "upload_time": "2024-03-15T14:27:28",
            "upload_time_iso_8601": "2024-03-15T14:27:28.540160Z",
            "url": "https://files.pythonhosted.org/packages/5b/8e/d48d5b3f77e40d09c12933c23c6951624d919f4400ddb8ae29f4f9d700db/ipyaladin-0.3.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-15 14:27:28",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ipyaladin"
}
Elapsed time: 0.22561s