{"id":13636399,"url":"https://github.com/cds-astro/aladin-lite","last_synced_at":"2025-04-19T08:32:13.923Z","repository":{"id":37270656,"uuid":"102606098","full_name":"cds-astro/aladin-lite","owner":"cds-astro","description":"An astronomical HiPS visualizer in the browser","archived":false,"fork":false,"pushed_at":"2025-04-16T16:23:13.000Z","size":124209,"stargazers_count":108,"open_issues_count":53,"forks_count":46,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-16T22:19:21.864Z","etag":null,"topics":["astronomy","hips","images","javascript","virtual-observatory","visualizer"],"latest_commit_sha":null,"homepage":"https://aladin.cds.unistra.fr/AladinLite/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","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","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":"codemeta.json","zenodo":".zenodo.json"}},"created_at":"2017-09-06T12:33:03.000Z","updated_at":"2025-04-14T03:46:38.000Z","dependencies_parsed_at":"2025-04-16T16:44:49.173Z","dependency_job_id":"27fc2397-1053-4610-b4bb-34f628dfe3a9","html_url":"https://github.com/cds-astro/aladin-lite","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cds-astro%2Faladin-lite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cds-astro%2Faladin-lite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cds-astro%2Faladin-lite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cds-astro%2Faladin-lite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cds-astro","download_url":"https://codeload.github.com/cds-astro/aladin-lite/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249327545,"owners_count":21251901,"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":["astronomy","hips","images","javascript","virtual-observatory","visualizer"],"created_at":"2024-08-02T00:01:00.856Z","updated_at":"2025-04-19T08:32:13.896Z","avatar_url":"https://github.com/cds-astro.png","language":"JavaScript","funding_links":[],"categories":["Libraries","JavaScript"],"sub_categories":["Astronomy"],"readme":"# [Aladin Lite](https://aladin.u-strasbg.fr/AladinLite)\n\n**An astronomical HiPS visualizer in the browser** \u003cimg src=\"aladin-logo.png\" alt=\"Aladin Lite logo\" width=\"220\"\u003e\n\nAladin Lite is a Web application which enables HiPS visualization from the browser. It is developed at [CDS, Strasbourg astronomical data center](http://cds.unistra.fr/).\n\nSee [A\u0026A 578, A114 (2015)](https://arxiv.org/abs/1505.02291) and [IVOA HiPS Recommendation](http://ivoa.net/documents/HiPS/index.html) for more details about the HiPS standard.\n\nAladin Lite is built to be easily embeddable in any web page. It powers astronomical portals like [ESASky](https://sky.esa.int/), [ESO Science Archive portal](http://archive.eso.org/scienceportal/) and [ALMA Portal](https://almascience.eso.org/asax/).\n\nMore details on [Aladin Lite documentation page](http://aladin.u-strasbg.fr/AladinLite/doc/).\nA new [API technical documentation](https://cds-astro.github.io/aladin-lite/) is now available.\n\n[![Run tests](https://github.com/cds-astro/aladin-lite/actions/workflows/test.yml/badge.svg)](https://github.com/cds-astro/aladin-lite/actions/workflows/test.yml)\n[![API Documentation](https://img.shields.io/badge/API-documentation-blue.svg)](https://cds-astro.github.io/aladin-lite)\n[![Releases page](https://img.shields.io/badge/Releases-forge-yellow.svg)](https://aladin.cds.unistra.fr/AladinLite/doc/release/)\n\nAladin Lite is available [at this link](https://aladin.u-strasbg.fr/AladinLite).\n\n## Running \u0026 editable JS examples\n\n\u003c!-- Examples --\u003e\n\u003ctable\u003e\u003ctbody\u003e\n\u003ctr\u003e\u003ctd\u003eBasic Aladin Lite setup\u003c/td\u003e\u003ctd\u003eLoad SIMBAD \u0026 NED catalog data\u003c/td\u003e\u003ctd\u003eLoad a FITS image\u003c/td\u003e\u003c/tr\u003e\n    \u003ctr\u003e\u003ctd align=\"left\"\u003e\u003ca href=\"https://aladin.cds.unistra.fr/AladinLite/doc/API/examples/AL-in-responsive-div/\"\u003e\u003cimg height=\"200\" src=\"https://github.com/cds-astro/aladin-lite/blob/develop/assets/vignettes/Basic%20Aladin%20Lite%20instanciation.png?raw=true\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\n        \u003ctd align=\"center\"\u003e\u003ca href=\"https://aladin.cds.unistra.fr/AladinLite/doc/API/examples/easy-access-simbad-ned/\"\u003e\u003cimg height=\"200\" src=\"https://github.com/cds-astro/aladin-lite/blob/develop/assets/vignettes/Load%20SIMBAD%20\u0026%20NED%20catalogs%20data.png?raw=true\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\n        \u003ctd align=\"right\"\u003e\u003ca href=\"https://aladin.cds.unistra.fr/AladinLite/doc/API/examples/load-FITS-image-URL/\"\u003e\u003cimg height=\"200\" src=\"https://github.com/cds-astro/aladin-lite/blob/develop/assets/vignettes/Load%20a%20FITS%20image.png?raw=true\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\n        \u003ctd\u003eAmerican Astronomical Society 225\u003cbr/\u003eexample\u003c/td\u003e\u003ctd\u003eDisplay proper motion vectors\u003c/td\u003e\u003ctd\u003eVisualization of Mars\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\n            \u003ctd align=\"left\"\u003e\u003ca href=\"https://aladin.cds.unistra.fr/AladinLite/doc/API/examples/AAS225/\"\u003e\u003cimg height=\"200\" src=\"https://github.com/cds-astro/aladin-lite/blob/develop/assets/vignettes/American%20Astronomical%20Society%20225%20demonstration.png?raw=true\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\n            \u003ctd align=\"center\"\u003e\u003ca href=\"https://aladin.cds.unistra.fr/AladinLite/doc/API/examples/show-proper-motions/\"\u003e\u003cimg height=\"200\" src=\"https://github.com/cds-astro/aladin-lite/blob/develop/assets/vignettes/Display%20proper%20motions.png?raw=true\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\n            \u003ctd align=\"right\"\u003e\u003ca href=\"https://aladin.cds.unistra.fr/AladinLite/doc/API/examples/mars-visualisation/\"\u003e\u003cimg height=\"200\" src=\"https://github.com/cds-astro/aladin-lite/blob/develop/assets/vignettes/Visualization%20of%20Mars.png?raw=true\"\u003e\u003c/img\u003e\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\n\u003c!-- Examples --\u003e\n\n## Releases\n\nA [release page](https://aladin.cds.unistra.fr/AladinLite/doc/release/) keeps track of all the current and previous builds.\nA ``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.\n\n\u003e [!TIP]\n\u003e 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:\n\u003e\n\u003e ```https://aladin.cds.unistra.fr/AladinLite/api/v3/\u003cversion\u003e/aladin.js```\n\n## Documentation\n\nThere is a new API documentation available [here](https://cds-astro.github.io/aladin-lite).\nEditable examples showing the API can also be found [here](https://aladin.cds.unistra.fr/AladinLite/doc/API/examples/).\n\n## Embed it into your projects\n\n**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.\n\nYou can embed Aladin Lite it into your webpages in two ways\n\n### The vanilla way\n\nPlease include [the javascript script of Aladin Lite v3](https://aladin.cds.unistra.fr/AladinLite/api/v3/latest/aladin.js) 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:\n\n```html\n\u003c!doctype html\u003e\n\u003chtml\u003e\n\u003chead\u003e\n    \u003c!-- Mandatory when setting up Aladin Lite v3 for a smartphones/tablet usage --\u003e\n    \u003cmeta name=\"viewport\" content=\"width=device-width, height=device-height, initial-scale=1.0, user-scalable=no\"\u003e\n\u003c/head\u003e\n\u003cbody\u003e\n\n\u003cdiv id=\"aladin-lite-div\" style=\"width: 500px; height: 400px\"\u003e\u003c/div\u003e\n\u003cscript type=\"text/javascript\" src=\"https://aladin.cds.unistra.fr/AladinLite/api/v3/latest/aladin.js\" charset=\"utf-8\"\u003e\u003c/script\u003e\n\n\u003cscript type=\"text/javascript\"\u003e\n    let aladin;\n    A.init.then(() =\u003e {\n        aladin = A.aladin('#aladin-lite-div', {fov: 360, projection: \"AIT\", cooFrame: 'equatorial', showCooGridControl: true, showSimbadPointerControl: true, showCooGrid: true});\n    });\n\u003c/script\u003e\n\n\u003c/body\u003e\n\u003c/html\u003e\n```\n\n### NPM deployment\n\nA [NPM package](https://www.npmjs.com/package/aladin-lite) is deployed and maintained. It is used by [ipyaladin](https://github.com/cds-astro/ipyaladin), a jupyter widget allowing to run aladin lite in a notebook.\n\n```npm i aladin-lite```\n\nAladin Lite can be imported with:\n\n```html\n\u003cscript type=\"module\"\u003e\n    import A from 'aladin-lite';\n    // your code...\n\u003c/script\u003e\n```\n\n## New features\n\n* [X] Rust/WebGL2 new rendering engine\n* [X] Remove jQuery dep\n* [ ] UI dev, better support for smartphones\n* [X] FITS images support\n* [X] WCS parsing, displaying an (JPEG/PNG) image in aladin lite view\n* [X] Display customized shapes (e.g. proper motions) from astronomical catalog data\n* [X] AVM tags parsing support\n* [X] Easy sharing of current « view »\n* [ ] All VOTable serializations\n* [ ] FITS tables\n* [X] Creating HiPS instance from an URL\n* [X] Local HiPS loading \n* [X] Multiple mirrors handling for HiPS tile retrival\n* [ ] HiPS cube\n\n## Licence\n\nAladin Lite is currently licensed under GPL v3.0\n\nIf you think this license might prevent you from using Aladin Lite in your pages/application/portal, please open an issue or [contact us](mailto:cds-question@unistra.fr)\n\n## Contribution guidelines\n\nThere are several ways to contribute to Aladin Lite:\n\n- **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.\n\n- **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.\n\n- **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.\nIn any case, please get in touch before starting a major update or rewrite.\n\n### Building steps\n\nFirst you need to install the dependencies from the package.json\nPlease run:\n\n```sh\nnpm install\n```\n\nAfter that you are supposed to have the Rust toolchain installed\nto compile the core project into WebAssembly.\nFollow the steps from the Rust official website [here](https://www.rust-lang.org/learn/get-started)\nYou will also need [wasm-pack](https://rustwasm.github.io/wasm-pack/), a tool helping compiling rust into a proper .wasm file.\n\nThen you can build the project:\n\n```sh\nnpm run build\n```\n\n\u003e [!WARNING]\n\u003e **If you are experimenting Rust compiling issues:**\n\u003e - Make sure you have your **wasm-pack** version updated. To do so:\n\u003e ```sh\n\u003e cargo install wasm-pack --version ~0.12\n\u003e ```\n\u003e - Remove your `src/core/Cargo.lock` file and `src/core/target` directory -- this ensures that you'd escape any bad compilation state:\n\u003e ```sh\n\u003e git clean -di\n\u003e ```\n\u003e - Then recompile\n\u003e ```sh\n\u003e npm run build\n\u003e ```\n\nIt 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.\n\n### Testing guidelines\n\n#### Run the examples\n\nA bunch of examples are located into the `examples` directory.\nTo run them, start a localhost server:\n\n```sh\nnpm run serve\n```\n\n#### Rust tests\n\nThese can be executed separately from the JS part:\n\n* Compile the Rust code:\n\n```sh\ncd src/core\ncargo check --features webgl2\n```\n\n* Run the tests:\n\n```sh\ncargo test --features webgl2\n```\n\n#### Snapshot comparisons\n\nWe use [playwright](https://playwright.dev/) for snapshot comparison testing. Only ground truth snapshots have been generated for MacOS/Darwin architecture.\nFirst install playwright:\n\n```sh\nnpx playwright install\n```\n\nRun the tests, advises are given for opening the UI mode or for generating your own ground truth snapshots.\n\n```sh\nnpm run test:playwright\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcds-astro%2Faladin-lite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcds-astro%2Faladin-lite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcds-astro%2Faladin-lite/lists"}