Metadata-Version: 2.4
Name: mast-aladin
Version: 0.0.2
Summary: Visualize MAST data products in Aladin Lite
Author-email: mast-aladin developers <help@stsci.edu>
License: BSD 3-Clause License
        
        Copyright (c) 2025, Space Telescope Science Institute
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://mast-aladin.readthedocs.io/en/latest/
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: astroquery
Requires-Dist: sidecar
Requires-Dist: jdaviz
Requires-Dist: traitlets
Requires-Dist: ipypopout
Requires-Dist: ipyvuetify
Requires-Dist: ipywidgets
Requires-Dist: solara
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx-astropy[confv2]>=1.9.1; extra == "docs"
Requires-Dist: sphinx_design; extra == "docs"
Dynamic: license-file

.. image:: https://github.com/spacetelescope/mast-aladin/actions/workflows/ci_workflows.yml/badge.svg
    :target: https://github.com/spacetelescope/mast-aladin/actions/workflows/ci_workflows.yml
    :alt: GitHub Actions CI Status

.. image:: https://codecov.io/gh/spacetelescope/mast-aladin/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/spacetelescope/mast-aladin

.. image:: https://readthedocs.org/projects/mast-aladin/badge/?version=latest
    :target: https://mast-aladin.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

mast-aladin
===========

.. warning::

    mast-aladin is currently in heavy development and breaking changes may occur without warning.


While we experiment with Aladin Lite integration in MAST platforms, this repository can be used to contain:

- documentation
- support code for wrapping and integrating Aladin Lite
- demonstration notebooks

Once design plans become more concrete, we can decide whether to keep using this repository.

Installing
----------

Installing ``mast-aladin`` in a new virtual or conda environment will help you to avoid 
version conflicts with other packages you may have installed, for example:

.. code-block:: bash

   conda create -n mast-aladin-env python=3.11
   conda activate mast-aladin-env

You can install the latest stable release version of ``mast-aladin`` using pip:

.. code-block:: bash

   pip install mast-aladin --upgrade

Or, you can install the latest development version of ``mast-aladin`` using pip:

.. code-block:: bash

   pip install git+https://github.com/spacetelescope/mast-aladin --upgrade

For details on installing and using mast-aladin, see the
`mast-aladin Installation <https://mast-aladin.readthedocs.io/en/latest/installation.html>`_.

Help
----------

If you encounter any unreported bugs or issues, please `open a GitHub issue <https://github.com/spacetelescope/mast-aladin/issues/new/choose>`_

License & Attribution
---------------------

This project is Copyright (c) Space Telescope Science Institute and licensed under
the terms of the BSD 3-Clause license. See the
`licenses <https://github.com/spacetelescope/mast-aladin/tree/main/licenses>`_
folder for more information on works the mast-aladin package is derived from or distributes.
