Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/caltech-ipac/firefly_client

Python API for Firefly
https://github.com/caltech-ipac/firefly_client

ipac-firefly python python-api visualization

Last synced: 6 days ago
JSON representation

Python API for Firefly

Awesome Lists containing this project

README

        

# 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.