Skip to content

Commit 5861c42

Browse files
Add a reference notebook and update demo notebooks in TOC
1 parent be1c156 commit 5861c42

File tree

3 files changed

+851
-12
lines changed

3 files changed

+851
-12
lines changed

docs/usage/demo-notebooks.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
###############
2+
Demo Notebooks
3+
###############
4+
5+
6+
Reference Guide
7+
-----------------
8+
9+
For a high-level overview of the Firefly Python client API and important methods, refer to this `reference guide notebook`.
10+
11+
.. _`reference guide notebook`:
12+
https://nbviewer.org/github/Caltech-IPAC/firefly_client/tree/master/examples/reference-guide.ipynb.
13+
14+
15+
Science Use-cases
16+
-----------------
17+
18+
IRSA Tutorials is collection of multiple notebooks that demonstrate the use of IRSA data services and tools for science use-cases.
19+
The following notebook demonstrates the use of Firefly Python Client:
20+
- https://caltech-ipac.github.io/irsa-tutorials/tutorials/firefly/SEDs_in_Firefly.html
21+
- https://caltech-ipac.github.io/irsa-tutorials/tutorials/firefly/NEOWISE_light_curve_demo.html
22+
- https://caltech-ipac.github.io/irsa-tutorials/tutorials/firefly/OpenUniverse2024Preview_Firefly.html
23+
- https://caltech-ipac.github.io/irsa-tutorials/tutorials/euclid_access/4_Euclid_intro_PHZ_catalog.html#vizualize-the-image-with-firefly
24+
25+
26+
Other Examples
27+
---------------
28+
29+
For a full list of notebooks/scripts that demonstrate the use of
30+
Firefly Python client, refer to |nbviewer_examples| (rendered in nbviewer).
31+
32+
.. warning::
33+
Several of the notebooks in the examples directory use deprecated API (or discouraged API that is about to be deprecated) and will be updated soon.
34+
35+
36+
.. |nbviewer_examples| raw:: html
37+
38+
<a href="https://nbviewer.org/github/Caltech-IPAC/firefly_client/tree/master/examples/"
39+
target="_blank">this examples directory</a>

docs/usage/index.rst

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,4 @@ Using firefly_client
1212
viewing-tables
1313
charting
1414
callbacks-extensions
15-
16-
17-
Examples
18-
--------
19-
20-
You can find a list of notebooks/scripts that demonstrate the use of
21-
firefly_client in |nbviewer_examples|.
22-
23-
.. |nbviewer_examples| raw:: html
24-
25-
<a href="https://nbviewer.org/github/Caltech-IPAC/firefly_client/tree/master/examples/"
26-
target="_blank">this directory (rendered in nbviewer)</a>
15+
demo-notebooks

0 commit comments

Comments
 (0)