{"id":28124695,"url":"https://github.com/caltech-ipac/firefly-workshop","last_synced_at":"2025-05-14T09:19:28.762Z","repository":{"id":269111986,"uuid":"906038827","full_name":"Caltech-IPAC/firefly-workshop","owner":"Caltech-IPAC","description":"Tutorial notebooks on using Firefly in Python","archived":false,"fork":false,"pushed_at":"2025-01-07T01:15:18.000Z","size":27,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-07T02:24:56.408Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Caltech-IPAC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-20T03:17:24.000Z","updated_at":"2025-01-07T01:15:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"d928f846-9daf-4200-83f7-09d94d287b1c","html_url":"https://github.com/Caltech-IPAC/firefly-workshop","commit_stats":null,"previous_names":["caltech-ipac/firefly-workshop"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Caltech-IPAC%2Ffirefly-workshop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Caltech-IPAC%2Ffirefly-workshop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Caltech-IPAC%2Ffirefly-workshop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Caltech-IPAC%2Ffirefly-workshop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Caltech-IPAC","download_url":"https://codeload.github.com/Caltech-IPAC/firefly-workshop/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254110422,"owners_count":22016392,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-14T09:18:53.214Z","updated_at":"2025-05-14T09:19:28.753Z","avatar_url":"https://github.com/Caltech-IPAC.png","language":"Jupyter Notebook","readme":"# Firefly Workshop\nTutorial notebooks on using the Firefly Python client (and Jupyter Lab extension)\nto visualize astronomical data as images, tables, charts, and more!\n\n## Setup Workshop Environment\n\n### Prerequisites\nIf you don't have the following installed already,\n- **miniconda**: Install by following the steps at https://docs.anaconda.com/miniconda/install/#quick-command-line-install\n- **git**: Install from https://git-scm.com/downloads\n\n\u003e Note: If you're using Windows, it is *highly recommended* to use [Windows \nSubsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install)\nfor fewer installation headaches. \n\n### Setup instructions\n1. Clone this repository on your machine:\n    ```sh\n    git clone https://github.com/Caltech-IPAC/firefly-workshop\n    cd firefly-workshop\n    ```\n\n2. Create Python environment with all the necessary dependencies including Firefly Python client and Jupyter Lab extension:\n    ```sh\n    conda env create --file environment.yml\n    conda activate firefly-py-env\n    ```\n    The name of the new conda environment created above should be displayed next to the terminal prompt:\n    ```\n    (firefly-py-env)\n    ```\n\n3. Set the environment variable for Firefly server to let the Firefly Jupyter Lab extension know which server to talk to from the Python client. We use a public Firefly server - IRSA Viewer:\n    ```sh\n    export FIREFLY_URL=https://irsa.ipac.caltech.edu/irsaviewer\n    ```\n\n4. Open the repository in Jupyter Lab:\n    ```sh\n    jupyter lab\n    ```\n\n\n## Reference/Cheatsheet\n\nOnce you have completed the setup instructions above, you are ready to visualise\nyour data files from Jupyter Lab in Firefly using the Firefly Python client\n([firefly_client](https://caltech-ipac.github.io/firefly_client) package).\n\nGo through the [Reference](Reference.ipynb) notebook present in this repository\nto learn how to use different capabilities of `firefly_client`. \n\nThe following is a condensed list of all the pages in firefly_client's\n[documentation website](https://caltech-ipac.github.io/firefly_client/index.html)\nthat are most relevant for this workshop:\n- [FireflyClient API reference](https://caltech-ipac.github.io/firefly_client/api/firefly_client.FireflyClient.html):\nYou can use \"Methods Summary\" table to navigate to learn about the function\nyou are interested in and its parameters.\n- [Displaying Images using Firefly client](https://caltech-ipac.github.io/firefly_client/usage/displaying-images.html)\n- [Visualizing Tables and Catalogs using Firefly client](https://caltech-ipac.github.io/firefly_client/usage/viewing-tables.html)\n- [Visualizing ds9-style Regions using Firefly client](https://caltech-ipac.github.io/firefly_client/usage/overlaying-regions.html)\n- [Making Plots using Firefly client](https://caltech-ipac.github.io/firefly_client/usage/charting.html)\n\n\n## Exercises\n\nWe have 3 notebooks demonstrating how to visualize astronomical data from Python\nusing Firefly in [exercises](exercises/) directory:\n- [Using Firefly to Explore OpenUniverse2024 Data Preview Simulated Roman and Rubin Images](exercises/OpenUniverse2024Preview_Firefly.ipynb)\n- [Using Firefly visualization tools in Python to vet SEDs](exercises/SEDs_in_Firefly.ipynb)\n- [Using Firefly visualization tools to understand the light curves of Solar System objects](exercises/NEOWISE_light_curve_demo.ipynb)\n\n\n## Solutions\n\nThe solutions of the above exercise notebooks are present at [Firefly section in\nIRSA Tutorials](https://caltech-ipac.github.io/irsa-tutorials/#interactive-visualization-in-python-with-firefly) website.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaltech-ipac%2Ffirefly-workshop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaltech-ipac%2Ffirefly-workshop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaltech-ipac%2Ffirefly-workshop/lists"}