aladin-lite

An astronomical HiPS visualizer in the browser

https://github.com/cds-astro/aladin-lite

Keywords

astronomy hips images javascript virtual-observatory visualizer

Last synced: 7 months ago · JSON representation

Repository

An astronomical HiPS visualizer in the browser

Basic Info

Host: GitHub
Owner: cds-astro
License: gpl-3.0
Language: JavaScript
Default Branch: master
Homepage: https://aladin.cds.unistra.fr/AladinLite/
Size: 120 MB

Statistics

Stars: 119
Watchers: 11
Forks: 49
Open Issues: 63
Releases: 13

Topics

astronomy hips images javascript virtual-observatory visualizer

Created over 8 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog License Authors Codemeta Zenodo

Aladin Lite

An astronomical HiPS visualizer in the browser

Aladin Lite is a Web application which enables HiPS visualization from the browser. It is developed at CDS, Strasbourg astronomical data center.

See A&A 578, A114 (2015) and IVOA HiPS Recommendation for more details about the HiPS standard.

Aladin Lite is built to be easily embeddable in any web page. It powers astronomical portals like ESASky, ESO Science Archive portal and ALMA Portal.

More details on Aladin Lite documentation page. A new API technical documentation is now available.

Aladin Lite is available at this link.

Running & editable JS examples

Basic Aladin Lite setup	Load SIMBAD & NED catalog data	Load a FITS image

American Astronomical Society 225 example	Display proper motion vectors	Visualization of Mars

Releases

A release page keeps track of all the current and previous builds. A release and beta versions, regularly updated are available. The beta version is usually more advanced than the release one but features more error prone and not production-ready code.

[!TIP] If you are working on a project that uses Aladin Lite, prefer working with a fixed version. Every build is tagged with a version number and accessible with:

https://aladin.cds.unistra.fr/AladinLite/api/v3/<version>/aladin.js

Documentation

There is a new API documentation available here. Editable examples showing the API can also be found here.

Embed it into your projects

Terms of use: you are welcome to integrate Aladin Lite in your web pages and to customize its GUI to your needs, but please leave the Aladin logo and link intact at the bottom right of the view.

You can embed Aladin Lite it into your webpages in two ways

The vanilla way

Please include the javascript script of Aladin Lite v3 into your project. API differences from the v2 are minimal, here is a snippet of code you can use to embed it into your webpages:

```html <!doctype html>

```

NPM deployment

A NPM package is deployed and maintained. It is used by ipyaladin, a jupyter widget allowing to run aladin lite in a notebook.

npm i aladin-lite

Aladin Lite can be imported with:

html <script type="module"> import A from 'aladin-lite'; // your code... </script>

New features

[X] Rust/WebGL2 new rendering engine
[X] Remove jQuery dep
[ ] UI dev, better support for smartphones
[X] FITS images support
[X] WCS parsing, displaying an (JPEG/PNG) image in aladin lite view
[X] Display customized shapes (e.g. proper motions) from astronomical catalog data
[X] AVM tags parsing support
[X] Easy sharing of current « view »
[ ] All VOTable serializations
[ ] FITS tables
[X] Creating HiPS instance from an URL
[X] Local HiPS loading
[X] Multiple mirrors handling for HiPS tile retrival
[ ] HiPS cube

Licence

Aladin Lite is currently licensed under GPL v3.0

If you think this license might prevent you from using Aladin Lite in your pages/application/portal, please open an issue or contact us

Contribution guidelines

There are several ways to contribute to Aladin Lite:

report a bug: anyone is welcome to open an issue to report a bug. Please make sure first the issue does not exist yet. Be as specific as possible, and provide if possible detailed instructions about how to reproduce the problem.
suggest a new feature: if you feel something is missing, check first if a similar feature request has not already been submitted in the open issues. If not, open a new issue, and give a detailed explanation of the feature you wish.
develop new features/provide code fixing bugs. As open development is a new thing for us, we will in a first time only take into consideration code contribution (i.e. Pull Requests) from our close partners. In any case, please get in touch before starting a major update or rewrite.

Building steps

First you need to install the dependencies from the package.json Please run:

sh npm install

After that you are supposed to have the Rust toolchain installed to compile the core project into WebAssembly. Follow the steps from the Rust official website here You will also need wasm-pack, a tool helping compiling rust into a proper .wasm file.

Then you can build the project:

sh npm run build

[!WARNING] If you are experimenting Rust compiling issues: - Make sure you have your wasm-pack version updated. To do so: sh cargo install wasm-pack --version ~0.12 - Remove your src/core/Cargo.lock file and src/core/target directory -- this ensures that you'd escape any bad compilation state: sh git clean -di - Then recompile sh npm run build

It will generate the aladin lite compiled code into a dist/ directory located at the root of the repository. This directory contains two javascript files. aladin.umd.cjs follows the UMD module export convention and it is the one you need to use for your project.

Testing guidelines

Run the examples

A bunch of examples are located into the examples directory. To run them, start a localhost server:

sh npm run serve

Rust tests

These can be executed separately from the JS part:

Compile the Rust code:

sh cd src/core cargo check --features webgl2

Run the tests:

sh cargo test --features webgl2

Snapshot comparisons

We use playwright for snapshot comparison testing. Only ground truth snapshots have been generated for MacOS/Darwin architecture. First install playwright:

sh npx playwright install

Run the tests, advises are given for opening the UI mode or for generating your own ground truth snapshots.

sh npm run test:playwright

Owner

Name: CDS (Centre de Données astronomiques de Strasbourg)
Login: cds-astro
Kind: organization

Website: http://cds.unistra.fr/
Repositories: 31
Profile: https://github.com/cds-astro

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "codeRepository": "https://github.com/cds-astro/aladin-lite",
  "dateCreated": "2013-05-01",
  "datePublished": "2013-05-01",
  "dateModified": "2023-01-31",
  "issueTracker": "https://github.com/cds-astro/aladin-lite/issues",
  "name": "Aladin Lite",
  "version": "3.6.1",
  "softwareVersion": "3.6.1",
  "description": "An astronomical HiPS visualizer in the browser.",
  "identifier": "10.5281/zenodo.7638833",
  "applicationCategory": "Astronomy, Visualization",
  "funding": "ESCAPE 824064",
  "referencePublication": "http://aspbooks.org/publications/532/007.pdf",
  "readme": "https://aladin.cds.unistra.fr/AladinLite/doc/",
  "releaseNotes": "https://aladin.cds.unistra.fr/AladinLite/doc/#release-notes",
  "funder": {
    "@type": "Organization",
    "name": "European Commission Framework Programme Horizon 2020 Research and Innovation action"
  },
  "keywords": [
    "IVOA",
    "Astronomy"
  ],
  "programmingLanguage": [
    "Rust",
    "Javascript"
  ],
  "relatedLink": [
    "https://aladin.cds.unistra.fr/"
  ],
  "author": [
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0002-7123-773X",
      "givenName": "Matthieu",
      "familyName": "Baumann",
      "email": "matthieu.baumann@unistra.fr",
      "affiliation": {
        "@type": "Organization",
        "name": "Université de Strasbourg, CNRS, Observatoire astronomique de Strasbourg, UMR 7550, F-67000 Strasbourg, France"
      }
    },
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0001-5818-2781",
      "givenName": "Thomas",
      "familyName": "Boch",
      "email": "thomas.boch@astro.unistra.fr",
      "affiliation": {
        "@type": "Organization",
        "name": "Université de Strasbourg, CNRS, Observatoire astronomique de Strasbourg, UMR 7550, F-67000 Strasbourg, France"
      }
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0002-7123-773X",
      "givenName": "Matthieu",
      "familyName": "Baumann",
      "email": "matthieu.baumann@unistra.fr",
      "affiliation": {
        "@type": "Organization",
        "name": "Université de Strasbourg, CNRS, Observatoire astronomique de Strasbourg, UMR 7550, F-67000 Strasbourg, France"
      }
    },
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0001-5818-2781",
      "givenName": "Thomas",
      "familyName": "Boch",
      "email": "thomas.boch@astro.unistra.fr",
      "affiliation": {
        "@type": "Organization",
        "name": "Université de Strasbourg, CNRS, Observatoire astronomique de Strasbourg, UMR 7550, F-67000 Strasbourg, France"
      }
    }
  ]
}

GitHub Events

Total

Create event: 44
Release event: 5
Issues event: 106
Watch event: 20
Delete event: 35
Issue comment event: 199
Push event: 172
Pull request review event: 7
Pull request review comment event: 4
Pull request event: 77
Fork event: 12

Last Year

Create event: 44
Release event: 5
Issues event: 106
Watch event: 20
Delete event: 35
Issue comment event: 199
Push event: 172
Pull request review event: 7
Pull request review comment event: 4
Pull request event: 77
Fork event: 12

Issues and Pull Requests

Last synced: 7 months ago

All Time

Total issues: 201
Total pull requests: 149
Average time to close issues: 11 months
Average time to close pull requests: 3 months
Total issue authors: 48
Total pull request authors: 17
Average comments per issue: 2.43
Average comments per pull request: 0.97
Merged pull requests: 121
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 74
Pull requests: 87
Average time to close issues: about 1 month
Average time to close pull requests: 4 days
Issue authors: 22
Pull request authors: 9
Average comments per issue: 1.97
Average comments per pull request: 0.4
Merged pull requests: 70
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

tboch (46)
bmatthieu3 (29)
lmichel (13)
imbasimba (12)
havok2063 (9)
alexgoff (9)
szpetny (8)
ManonMarchand (6)
OlivierMarchal (6)
ivan-katkov (4)
emellega (3)
vforchi (3)
Erard (3)
RobinMeneust (2)
bmiszalski (2)

Pull Request Authors

bmatthieu3 (81)
ManonMarchand (22)
tboch (14)
imbasimba (10)
Xen0Xys (8)
pmatsson (8)
szpetny (7)
alexgoff (4)
simontorres (4)
cquiroz (3)
emellega (2)
pcuste1 (2)
diego-ge (1)
HeosFx (1)
TSoliman2000 (1)

Top Labels

Issue Labels

bug (41) enhancement (38) feature (24) ui (6) regression (6) new feature (6) question (5) catalog (3) HiPS (3) help wanted (2) documentation (2) api (2) rendering (1) difficult (1) fits (1) workaround done (1)

Pull Request Labels

bug (18) new feature (5) enhancement (5) ui (3) testing (2) performance (2) documentation (2)

Packages

Total packages: 4
Total downloads:
- npm 1,616 last-month

Total dependent packages: 2
(may contain duplicates)
Total dependent repositories: 1
(may contain duplicates)
Total versions: 43
Total maintainers: 6

proxy.golang.org: github.com/cds-astro/aladin-lite

Documentation: https://pkg.go.dev/github.com/cds-astro/aladin-lite#section-documentation
License: gpl-3.0
Latest release: v3.2.0+incompatible
published over 2 years ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 6.5%

Average: 6.7%

Dependent repos count: 7.0%

Last synced: 7 months ago

npmjs.org: aladin-lite

An astronomical HiPS visualizer in the browser

Homepage: https://aladin.u-strasbg.fr/
License: GPL-3
Latest release: 3.6.5
published 12 months ago

Versions: 35
Dependent Packages: 1
Dependent Repositories: 1
Downloads: 1,601 Last month

Rankings

Forks count: 4.6%

Stargazers count: 5.7%

Downloads: 9.0%

Dependent repos count: 10.8%

Average: 16.8%

Dependent packages count: 53.7%

Maintainers (4)

bmatthieu3 fxpineau manon_marchand tboch

Last synced: 7 months ago

npmjs.org: @dngomez/aladin-lite

An astronomical HiPS visualizer in the browser

Homepage: https://aladin.u-strasbg.fr/
License: GPL-3
Latest release: 3.1.0
published almost 3 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 6 Last month

Rankings

Forks count: 4.5%

Stargazers count: 5.7%

Average: 25.6%

Dependent repos count: 37.5%

Dependent packages count: 54.7%

Maintainers (1)

dngomez

Last synced: 7 months ago

npmjs.org: aladin-lite-simon

An astronomical HiPS visualizer in the browser

Homepage: https://aladin.u-strasbg.fr/
License: GPL-3
Latest release: 3.1.3
published almost 3 years ago

Versions: 4
Dependent Packages: 1
Dependent Repositories: 0
Downloads: 9 Last month

Rankings

Forks count: 4.6%

Stargazers count: 5.8%

Average: 25.7%

Downloads: 26.5%

Dependent repos count: 37.5%

Dependent packages count: 54.0%

Maintainers (1)

simontorres

Last synced: 7 months ago

aladin-lite

Science Score: 36.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Aladin Lite

Running & editable JS examples

Releases

Documentation

Embed it into your projects

The vanilla way

NPM deployment

New features

Licence

Contribution guidelines

Building steps

Testing guidelines

Run the examples

Rust tests

Snapshot comparisons

Owner

CodeMeta (codemeta.json)

GitHub Events

Total

Last Year

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

proxy.golang.org: github.com/cds-astro/aladin-lite

Rankings

npmjs.org: aladin-lite

Rankings

Maintainers (4)

npmjs.org: @dngomez/aladin-lite

Rankings

Maintainers (1)

npmjs.org: aladin-lite-simon

Rankings

Maintainers (1)