Skip to content

Commit eb7b1ff

Browse files
Add astropy installation comment and env var setting instruction
1 parent 941380d commit eb7b1ff

4 files changed

Lines changed: 37 additions & 2 deletions

File tree

‎docs/usage/charting.ipynb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
},
2222
{
2323
"cell_type": "code",
24-
"execution_count": 1,
24+
"execution_count": null,
2525
"id": "d26d722f",
2626
"metadata": {},
2727
"outputs": [
@@ -40,7 +40,7 @@
4040
"from firefly_client import FireflyClient\n",
4141
"\n",
4242
"# Initialize a FireflyClient instance\n",
43-
"fc = FireflyClient.make_client(url=\"http://localhost:8080/firefly\")\n",
43+
"fc = FireflyClient.make_client(url=\"https://irsa.ipac.caltech.edu/irsaviewer\")\n",
4444
"\n",
4545
"# Display a catalog table (from URL of 2MASS TAP query for M51)\n",
4646
"table_url = \"http://irsa.ipac.caltech.edu/TAP/sync?FORMAT=IPAC_TABLE&QUERY=SELECT+*+FROM+fp_psc+WHERE+CONTAINS(POINT('J2000',ra,dec),CIRCLE('J2000',202.4841667,47.23055556,0.125))=1\"\n",

‎docs/usage/displaying-images.ipynb‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,17 @@
2929
"First, we create a `FireflyClient` instance and open a Firefly viewer. See [Initializing a FireflyClient instance](./initializing-vanilla.html) for more details."
3030
]
3131
},
32+
{
33+
"cell_type": "code",
34+
"execution_count": null,
35+
"id": "42fb0b65",
36+
"metadata": {},
37+
"outputs": [],
38+
"source": [
39+
"# Uncomment the next line to install dependencies if needed.\n",
40+
"# !pip install firefly-client astropy"
41+
]
42+
},
3243
{
3344
"cell_type": "code",
3445
"execution_count": 1,

‎docs/usage/initializing-vanilla.ipynb‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
" - IRSA Viewer at https://irsa.ipac.caltech.edu/irsaviewer\n",
1919
" - Rubin Science Platform Portal at https://data.lsst.cloud/portal/app/ (requires authentication; the `ACCESS_TOKEN` environment variable must be set)\n",
2020
"\n",
21+
"For example, in a bash/zsh shell, enter `export FIREFLY_URL=\"https://irsa.ipac.caltech.edu/irsaviewer\"` before launching the notebook via `jupyter lab` or `jupyter notebook` command.\n",
22+
"\n",
2123
"If `FIREFLY_URL` is not defined, the default server URL is `http://localhost:8080/firefly`, which is often used for a Firefly server running locally.\n",
2224
"\n",
2325
".. note::\n",
@@ -33,6 +35,17 @@
3335
"The only required import here is `FireflyClient`."
3436
]
3537
},
38+
{
39+
"cell_type": "code",
40+
"execution_count": null,
41+
"id": "4b61ec8f",
42+
"metadata": {},
43+
"outputs": [],
44+
"source": [
45+
"# Uncomment the next line if you have not installed the firefly-client package already.\n",
46+
"# !pip install firefly-client"
47+
]
48+
},
3649
{
3750
"cell_type": "code",
3851
"execution_count": 1,

‎docs/usage/viewing-tables.ipynb‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@
1919
"First, we create a `FireflyClient` instance and open a Firefly viewer. See [Initializing a FireflyClient instance](./initializing-vanilla.html) for more details. Then, we display a FITS image from a URL so that we have an image for catalog overlays. See [Displaying a FITS Image](./displaying-fits-image.html) for more details."
2020
]
2121
},
22+
{
23+
"cell_type": "code",
24+
"execution_count": null,
25+
"id": "cad23c03",
26+
"metadata": {},
27+
"outputs": [],
28+
"source": [
29+
"# Uncomment the next line to install dependencies if needed.\n",
30+
"# !pip install firefly-client astropy"
31+
]
32+
},
2233
{
2334
"cell_type": "code",
2435
"execution_count": 1,

0 commit comments

Comments
 (0)