{"_id":"@dngomez/aladin-lite","name":"@dngomez/aladin-lite","dist-tags":{"latest":"3.1.0"},"versions":{"3.1.0":{"homepage":"https://aladin.u-strasbg.fr/","name":"@dngomez/aladin-lite","type":"module","version":"3.1.0","description":"An astronomical HiPS visualizer in the browser","author":{"name":"Thomas Boch and Matthieu Baumann"},"license":"GPL-3","module":"./dist/aladin.js","main":"./dist/aladin.js","exports":{".":{"import":"./dist/aladin.js"}},"repository":{"type":"git","url":"git+https://github.com/cds-astro/aladin-lite.git"},"email":"cds-question@unistra.fr","keywords":["astronomy","visualization","rust","webgl","HiPS"],"scripts":{"wasm":"wasm-pack build ./src/core --target web --release --out-name core -- --features webgl2","package-tar":"tar -zcvf AladinLiteAssets.tar.gz dist/aladin.js","predeploy":"npm run build && npm run package-tar","deploy":"./deploy-dbg.sh","build":"npm run wasm && vite build && sed \"s/\\\\.\\\\/\\\\.\\\\.\\\\/aladin\\\\.js/https:\\\\/\\\\/aladin.cds.unistra.fr\\\\/AladinLite\\\\/api\\\\/v3\\\\/latest\\\\/aladin.js/g\" examples/index.html > dist/index.html","dev":"npm run build && vite","serve":"npm run dev","preview":"vite preview"},"devDependencies":{"npm":"^8.19.2","terser":"^5.17.6","vite":"^4.3.8","vite-plugin-css-injected-by-js":"^3.1.1","vite-plugin-glsl":"^1.1.2","vite-plugin-top-level-await":"^1.3.1","vite-plugin-wasm":"^3.2.2","vite-plugin-wasm-pack":"^0.1.12"},"dependencies":{"autocompleter":"^6.1.3","jquery":"^3.6.1"},"gitHead":"33fc5a3bb0c41765605fc75e1b6ef02099f9bc84","bugs":{"url":"https://github.com/cds-astro/aladin-lite/issues"},"_id":"@dngomez/aladin-lite@3.1.0","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-7KvQFxYMTTMc4AcLq2kXTW8/i7wS89vDVgW+Ezh79j54ab7B5GbH5Tg5nh0k50iRg6uhchG4X2l0TULipwBHNg==","shasum":"fbae67707d1d934a2971436157832c9a78792eb5","tarball":"https://registry.npmjs.org/@dngomez/aladin-lite/-/aladin-lite-3.1.0.tgz","fileCount":7,"unpackedSize":5325067,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDMposXr48Zpz84oMuq9H2IWknUjQq2XPKJKcx4rot2xAiEA44SIACtlp+wVQvCJfDMpc/FzLfALQOgaGatL3vpV89w="}]},"_npmUser":{"name":"dngomez","email":"dngomez.e@gmail.com"},"directories":{},"maintainers":[{"name":"dngomez","email":"dngomez.e@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aladin-lite_3.1.0_1685031814811_0.2644537716944346"},"_hasShrinkwrap":false}},"time":{"created":"2023-05-25T16:23:34.761Z","3.1.0":"2023-05-25T16:23:35.085Z","modified":"2023-05-25T16:23:35.272Z"},"maintainers":[{"name":"dngomez","email":"dngomez.e@gmail.com"}],"description":"An astronomical HiPS visualizer in the browser","homepage":"https://aladin.u-strasbg.fr/","keywords":["astronomy","visualization","rust","webgl","HiPS"],"repository":{"type":"git","url":"git+https://github.com/cds-astro/aladin-lite.git"},"author":{"name":"Thomas Boch and Matthieu Baumann"},"bugs":{"url":"https://github.com/cds-astro/aladin-lite/issues"},"license":"GPL-3","readme":"# Aladin Lite v3\n\n**An astronomical HiPS visualizer in the browser** <img src=\"aladin-logo.png\" alt=\"Aladin Lite logo\" width=\"220\">\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&A 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://almascience.eso.org/asax/), [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/).\n\n# How to test it ?\n\nAladin Lite v3 is out! Please play with [Aladin Lite v3 at this link](https://aladin.u-strasbg.fr/AladinLite).\n\n## Embed it into your projects\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```js\n<!doctype html>\n<html>\n<head>\n    <!-- Mandatory when setting up Aladin Lite v3 for a smartphones/tablet usage -->\n    <meta name=\"viewport\" content=\"width=device-width, height=device-height, initial-scale=1.0, user-scalable=no\">\n</head>\n<body>\n\n<div id=\"aladin-lite-div\" style=\"width: 500px; height: 400px\"></div>\n<script type=\"text/javascript\" src=\"https://aladin.cds.unistra.fr/AladinLite/api/v3/latest/aladin.js\" charset=\"utf-8\"></script>\n\n<script type=\"text/javascript\">\n    let aladin;\n    A.init.then(() => {\n        aladin = A.aladin('#aladin-lite-div', {fov: 360, projection: \"AIT\", cooFrame: 'equatorial', showCooGridControl: true, showSimbadPointerControl: true, showCooGrid: true});\n    });\n</script>\n\n</body>\n</html>\n```\n\n### Using the aladin lite NPM package\n\nFirst, install it with npm:\n\n```npm i aladin-lite```\n\nSecond, you can use it that way:\n\n```js\n<!doctype html>\n<html>\n<head>\n    <!-- Mandatory when setting up Aladin Lite v3 for a smartphones/tablet usage -->\n    <meta name=\"viewport\" content=\"width=device-width, height=device-height, initial-scale=1.0, user-scalable=no\">\n</head>\n<body>\n\n<div id=\"aladin-lite-div\" style=\"width: 500px; height: 400px\"></div>\n\n<script type=\"module\">\n    import A from 'aladin-lite';\n\n    A.init.then(() => {\n        let aladin = A.aladin('#aladin-lite-div', {fov: 360, projection: \"AIT\", cooFrame: 'equatorial', showCooGridControl: true, showSimbadPointerControl: true, showCooGrid: true});\n    });\n</script>\n\n</body>\n</html>\n```\n\n## Goals of v3\n\n- Rust/WebGL new core integration\n\n- Remove jQuery dep\n\n- UI dev, better support for smartphones\n\n- FITS images support\n\n- easy sharing of current « view »\n\n- support of all VOTable serializations (using votable.js?)\n\n- support of FITS tables?\n\n- creating HiPS instance from an URL\n\n- multiple mirrors handling for HiPS tile retrival\n\n## Source code\n\nSource code is available in the ``src`` directory.\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## Contributing\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 the application steps\n\nFirst you need to install the dependencies from the package.json\nPlease run:\n\n```bash\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\nOnce it's installed you can only build the project:\n```bash\nnpm run build\n```\n\nOr build it and launch a localhost server (usually starting on port 8080 but it can be another one if 8080 is occupied):\n```bash\nnpm run serve\n```\n\nFor just compiling the rust core from the root location (it is faster to do so)\n\n```bash\ncd src/core\ncargo check --features webgl2\n```\n\nand run the tests\n\n```bash\ncd src/core\ncargo test --features webgl2\n```\n\nTo generate the Rust backend API documentation\n\n```bash\ncd src/core\ncargo doc --no-deps --open\n```","readmeFilename":"README.md"}