Metadata-Version: 2.2
Name: firefly_client
Version: 3.3.0
Summary: Python API for Firefly: display astronomical data as tables, images, charts, and more!
Author: IPAC LSST SUIT
License: Copyright © <2014>, California Institute of Technology, developed for the 
        Spitzer Science Center and the NASA/IPAC Infrared Science Archive (IRSA) with 
        support from NASA, and for Large Synoptic Survey Telescope (LSST) with
        support from NSF. 
        
        All rights reserved.
        Redistribution and use in source and binary forms, with or without 
        modification, are permitted provided that the following conditions are met:
        
          * Redistributions of source code must retain the above copyright notice, 
            this list of conditions and the following disclaimer.
          * 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.
          * Neither the name of the California Institute of Technology (Caltech) 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://github.com/Caltech-IPAC/firefly_client
Project-URL: Documentation, https://caltech-ipac.github.io/firefly_client
Project-URL: Repository, http://github.com/Caltech-IPAC/firefly_client.git
Keywords: jupyter,firefly,caltech,ipac,astronomy,visualization,images,charts,tables
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: websocket-client
Requires-Dist: requests
Provides-Extra: docs
Requires-Dist: Sphinx~=7.1.0; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"

# firefly_client

Python API for Firefly, IPAC's Advanced Astronomy Web UI Framework

## Usage

The client must be connected to a Firefly server. The Firefly
repository is located at http://github.com/Caltech-IPAC/firefly.
Standalone Firefly servers may be obtained from
[this Dockerhub repository](https://hub.docker.com/r/ipac/firefly/).

For detailed explanation on the usage, see [the online documentation](https://caltech-ipac.github.io/firefly_client). Following is a very simple example:

```
from firefly_client import FireflyClient
fc = FireflyClient.make_client()  # can also explictly pass url of a firefly server; default is http://localhost:8080/firefly
```

A FITS image may be uploaded and displayed:

```
fval = fc.upload_file('image.fits')
fc.show_fits(fval, 'myimage')
```

For more examples, check notebooks & python files in the [examples](examples/) and [test](test/) directories.
