Skip to content

Commit be1c156

Browse files
Update readme to reflect current state of documentation
1 parent 9526472 commit be1c156

File tree

1 file changed

+5
-19
lines changed

1 file changed

+5
-19
lines changed

README.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,12 @@
11
# firefly_client
22

3-
Python API for Firefly, IPAC's Advanced Astronomy Web UI Framework
3+
Python API for [Firefly](http://github.com/Caltech-IPAC/firefly), IPAC's Advanced Astronomy Web UI Framework. This allows users to leverage Firefly in their Python notebooks for interactive exploration of astronomical data (images, catalogs, charts, regions, and more) with just a couple of lines of code.
44

5-
## Usage
65

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

12-
For detailed explanation on the usage, see [the online documentation](https://caltech-ipac.github.io/firefly_client). Following is a very simple example:
8+
You can find the documentation at https://caltech-ipac.github.io/firefly_client.
139

14-
```
15-
from firefly_client import FireflyClient
16-
fc = FireflyClient.make_client() # can also explictly pass url of a firefly server; default is http://localhost:8080/firefly
17-
```
10+
NOTE: Many parts of this documentation are a work in progress because the firefly_client API and its use cases evolved since it was written.
11+
Please report any issues or suggestions on the [GitHub issues](https://github.com/Caltech-IPAC/firefly_client/issues).
1812

19-
A FITS image may be uploaded and displayed:
20-
21-
```
22-
fval = fc.upload_file('image.fits')
23-
fc.show_fits(fval, 'myimage')
24-
```
25-
26-
For more examples, check notebooks & python files in the [examples](examples/) and [test](test/) directories.

0 commit comments

Comments
 (0)