| Name | firefly-client JSON |
| Version |
3.1.0
JSON |
| download |
| home_page | None |
| Summary | Python API for Firefly: display astronomical data as tables, images, charts, and more! |
| upload_time | 2024-08-30 18:33:24 |
| maintainer | None |
| docs_url | None |
| author | IPAC LSST SUIT |
| requires_python | >=3.8 |
| 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. |
| keywords |
jupyter
firefly
caltech
ipac
astronomy
visualization
images
charts
tables
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "firefly-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jupyter, firefly, caltech, ipac, astronomy, visualization, images, charts, tables",
"author": "IPAC LSST SUIT",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/40/c9/af9ea0b04f7e25b7a0e5901353490ed5676f457f999d8ef06efe1d83895a/firefly_client-3.1.0.tar.gz",
"platform": null,
"description": "# firefly_client\n\nPython API for Firefly, IPAC's Advanced Astronomy Web UI Framework\n\n## Usage\n\nThe client must be connected to a Firefly server. The Firefly\nrepository is located at http://github.com/Caltech-IPAC/firefly.\nStandalone Firefly servers may be obtained from\n[this Dockerhub repository](https://hub.docker.com/r/ipac/firefly/).\n\nFor detailed explanation on the usage, see [the online documentation](https://caltech-ipac.github.io/firefly_client). Following is a very simple example:\n\n```\nfrom firefly_client import FireflyClient\nfc = FireflyClient.make_client() # can also explictly pass url of a firefly server; default is http://localhost:8080/firefly\n```\n\nA FITS image may be uploaded and displayed:\n\n```\nfval = fc.upload_file('image.fits')\nfc.show_fits(fval, 'myimage')\n```\n\nFor more examples, check notebooks & python files in the [examples](examples/) and [test](test/) directories.\n",
"bugtrack_url": null,
"license": "Copyright \u00a9 <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. ",
"summary": "Python API for Firefly: display astronomical data as tables, images, charts, and more!",
"version": "3.1.0",
"project_urls": {
"Documentation": "https://caltech-ipac.github.io/firefly_client",
"Homepage": "https://github.com/Caltech-IPAC/firefly_client",
"Repository": "http://github.com/Caltech-IPAC/firefly_client.git"
},
"split_keywords": [
"jupyter",
" firefly",
" caltech",
" ipac",
" astronomy",
" visualization",
" images",
" charts",
" tables"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6bcc8389f18f29a051041420570743b41592455f6f15b340b9490a1dc46e7944",
"md5": "8f4d9eccb81edaa6c99499493985bad3",
"sha256": "7957c001e5eabb15c7503022e8b9c6a3e0c368abbc7d29717ce467ff50330e37"
},
"downloads": -1,
"filename": "firefly_client-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f4d9eccb81edaa6c99499493985bad3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 31337,
"upload_time": "2024-08-30T18:33:23",
"upload_time_iso_8601": "2024-08-30T18:33:23.369935Z",
"url": "https://files.pythonhosted.org/packages/6b/cc/8389f18f29a051041420570743b41592455f6f15b340b9490a1dc46e7944/firefly_client-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "40c9af9ea0b04f7e25b7a0e5901353490ed5676f457f999d8ef06efe1d83895a",
"md5": "76750a41b5a0ba5d4c9aebf1a9b3ac92",
"sha256": "6e398c8479a3310bb62150b753760d973a0992e04be8e12dc6da9ca614695e39"
},
"downloads": -1,
"filename": "firefly_client-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "76750a41b5a0ba5d4c9aebf1a9b3ac92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 60567,
"upload_time": "2024-08-30T18:33:24",
"upload_time_iso_8601": "2024-08-30T18:33:24.969886Z",
"url": "https://files.pythonhosted.org/packages/40/c9/af9ea0b04f7e25b7a0e5901353490ed5676f457f999d8ef06efe1d83895a/firefly_client-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-30 18:33:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Caltech-IPAC",
"github_project": "firefly_client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "firefly-client"
}
