Skip to content

Commit 10a4c8e

Browse files
committed
DM-7119, changed FIrefly Tools to Firefly APIs
1 parent 8ad9f2f commit 10a4c8e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ Firefly is being reused for various archives because it is a framework of archiv
1313

1414
By default, this repository builds a default example webapp. This tool can be used for viewing FITS data, catalogs, and xyplots. It is a general viewer tool for retrieving and viewing astronomy related data.
1515

16-
#### Firefly Tools
16+
#### Firefly APIs
1717

18-
Firefly Tools exposes the most powerful components of Firefly in a way that can be used by any web page with no prerequisites. It allows any web developer access to Firefly's FITS visualizers or Table Tool with just a very few lines of JavaScript. The goal is to make these tools very easy to use with only a 10 minute learning curve.
18+
Firefly APIs exposes the most powerful components of Firefly in a way that can be used by any web page with no prerequisites. It allows any web developer access to Firefly's FITS visualizers or Table Tool with just a very few lines of JavaScript. The goal is to make these APIs very easy to use with only a 10 minute learning curve.
1919

20-
An important feature is that the Firefly Tools server can be installed cross-site. In other words, it is not required to be on the same server as the web page. Firefly Tools can do this because it uses JSONP or CORS for the server communication. This allows Firefly Tools not to be limited by the server's Same Origin Policy and to give the developer a lot of flexibility. The web developer does not have to do any installation, but can simply just start using Firefly Tools.
20+
An important feature is that the Firefly APIs server can be installed cross-site. In other words, it is not required to be on the same server as the web page. Firefly APIs can do this because it uses JSONP or CORS for the server communication. This allows Firefly APIs not to be limited by the server's Same Origin Policy and to give the developer a lot of flexibility. The web developer does not have to do any installation, but can simply just start using Firefly APIs.
2121

2222
### Visualizers
2323
The firefly components contain 3 main visualizers for astronomy data.
2424

2525

2626
#### Tabular Display
27-
Firefly has implemented “Excel-like” tables on the webpage. In an easy, interactive way, a user can sort the results, filter the data on multiple constraints, hide or show columns or select data for download or visualization. The Firefly Tools server is optimized to show very large tables without significant performance degradation. We have tested it with over 10 million rows, 50 column tables.
27+
Firefly has implemented “Excel-like” tables on the webpage. In an easy, interactive way, a user can sort the results, filter the data on multiple constraints, hide or show columns or select data for download or visualization. The Firefly APIs server is optimized to show very large tables without significant performance degradation. We have tested it with over 10 million rows, 50 column tables.
2828

2929
#### FITS Visualization
3030
Firefly provides a first-class FITS visualization on the Web without any plugins. All of the significant components you would expect to see in a basic desktop FITS application are available with data that Firefly displays. The FITS visualizer allows for plotting anything that the table shows that has a Lon and Lat. Therefore, users can overlay multiple catalogs over their FITS image and interact with it.
@@ -93,14 +93,14 @@ The documentation is accessible via http://localhost:8080/firefly/jsdoc/index.ht
9393

9494
## More Docs
9595

96-
####Firefly Tools JavaScript API overview
96+
####Firefly JavaScript API overview
9797
See [firefly-api-overview.md](docs/firefly-api-overview.md)
9898
(Deprecated [docs/fftools-api-overview.md](docs/fftools-api-overview.md))
9999

100-
####Firefly Tools Remote API using Python overview
100+
####Firefly Remote API using Python overview
101101
See [firefly-python-wrapper.md](docs/firefly-python-wrapper.md)
102102

103-
####Code Examples Using Firefly Tools
103+
####Code Examples Using Firefly APIs
104104
See [firefly-api-code-examples.md](docs/firefly-api-code-examples.md)
105105
(Deprecated [docs/fftools-api-code-examples.md](docs/fftools-api-code-examples.md))
106106

0 commit comments

Comments
 (0)