Skip to content

Commit a7d47af

Browse files
committed
Rename files for clarity
1 parent 95bf01c commit a7d47af

18 files changed

Lines changed: 56 additions & 56 deletions

deploy_to_fornax_manifest.in

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ tutorials/simulated-data/roman_hlss_number_density.md
1818
tutorials/spherex/spherex_cutouts.md
1919
tutorials/spherex/spherex_intro.md
2020
tutorials/spherex/spherex_psf.md
21-
tutorials/spherex/spherex_sdt/conda-sdt_env.yml
22-
tutorials/spherex/spherex_sdt/README.md
23-
tutorials/spherex/spherex_sdt/sdt_irsa.md
24-
tutorials/spherex/spherex_sdt/spx_sdt/__init__.py
25-
tutorials/spherex/spherex_sdt/spx_sdt/aperture_photometry.py
26-
tutorials/spherex/spherex_sdt/spx_sdt/bokeh_viz.py
27-
tutorials/spherex/spherex_sdt/spx_sdt/default_sdt.param
28-
tutorials/spherex/spherex_sdt/spx_sdt/default_sdt.sex
29-
tutorials/spherex/spherex_sdt/spx_sdt/default.conv
30-
tutorials/spherex/spherex_sdt/spx_sdt/default.nnw
31-
tutorials/spherex/spherex_sdt/spx_sdt/firefly_viz.py
32-
tutorials/spherex/spherex_sdt/spx_sdt/sdt_utils.py
33-
tutorials/spherex/spherex_sdt/spx_sdt/source_extraction.py
21+
tutorials/spherex/spherex_source_discovery/conda-spherex_sdt.yml
22+
tutorials/spherex/spherex_source_discovery/README.md
23+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool_demo.md
24+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/__init__.py
25+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/aperture_photometry.py
26+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/bokeh_viz.py
27+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/default_sdt.param
28+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/default_sdt.sex
29+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/default.conv
30+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/default.nnw
31+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/firefly_viz.py
32+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/sdt_utils.py
33+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/source_extraction.py
3434
tutorials/spitzer/siav2_seip.md
3535
tutorials/techniques-and-tools/cloud-access-intro.md
3636
tutorials/techniques-and-tools/Parallelize_Convolution.md

ignore_tutorials/ignore_rendering_execution

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ tutorials/techniques-and-tools/Parallelize_Convolution
33
# Uses about 10G of memory which doesn't leave enough for other notebooks
44
tutorials/wise/wise-allwise-catalog-demo
55
# Requires source extractor, which requires a conda install
6-
tutorials/spherex/spherex_sdt/sdt_irsa.md
6+
tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool_demo.md

notebook_metadata.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
file: tutorials/euclid/3_Euclid_intro_1D_spectra.md
7878
description: Load a galaxy spectrum and plot it. Understand the wavelength, flux, and mask values.
7979
- title: Source Discovery Tool
80-
file: tutorials/spherex/spherex_sdt/sdt_irsa.md
80+
file: tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool_demo.md
8181
description: Discover, extract, and visualize sources from SPHEREx Spectral Images.
8282
- title: Spectral Image Cutouts
8383
file: tutorials/spherex/spherex_cutouts.md

toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ project:
1313
- title: PSF Models
1414
file: tutorials/spherex/spherex_psf.md
1515
- title: Source Discovery Tool
16-
file: tutorials/spherex/spherex_sdt/sdt_irsa.md
16+
file: tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool_demo.md
1717
- title: Euclid
1818
file: tutorials/euclid/euclid.md
1919
children:

tutorials/spherex/spherex.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ SPHEREx data releases include weekly [Quick Release spectral image products](htt
1212

1313
- [PSF Models](spherex_psf.md) - Understand how SPHEREx point spread function (PSF) information is organized and accessed.
1414

15-
- [Source Discovery Tool](spherex_sdt/sdt_irsa.md) - Discover, extract, and visualize sources from SPHEREx Spectral Images.
15+
- [Source Discovery Tool](spherex_source_discovery/spherex_source_discovery_tool_demo.md) - Discover, extract, and visualize sources from SPHEREx Spectral Images.

tutorials/spherex/spherex_sdt/README.md renamed to tutorials/spherex/spherex_source_discovery/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Overview
44

5-
The SPHEREx Source Discovery Tool is the Python package `spx_sdt` (included in this directory), which is used to discover and extract sources from SPHEREx Spectral Images and visualize their spectra.
6-
The notebook [](sdt_irsa.md) demonstrates how to use it.
5+
The SPHEREx Source Discovery Tool is the Python package `spherex_source_discovery_tool` (included in this directory), which is used to discover and extract sources from SPHEREx Spectral Images and visualize their spectra.
6+
The notebook [](spherex_source_discovery_tool_demo.md) demonstrates how to use it.
77

88
### Directory Contents
99

10-
- `sdt_irsa.md`: Demo notebook.
11-
- `conda-sdt_env.yml`: Conda environment definition file.
12-
- `spx_sdt/`: Python package, including functions and configuration files to extract and visualize sources.
10+
- `spherex_source_discovery_tool_demo.md`: Demo notebook.
11+
- `conda-spherex_sdt.yml`: Conda environment definition file.
12+
- `spherex_source_discovery_tool/`: Python package, including functions and configuration files to extract and visualize sources.
1313
- Python modules
1414
- `aperture_photometry.py`: Functions adapted from Zafar Rustamkulov to perform aperture photometry.
1515
- `bokeh_viz.py`: Functions for dynamic `bokeh` visualizations.
@@ -26,37 +26,37 @@ The notebook [](sdt_irsa.md) demonstrates how to use it.
2626

2727
### On local machine
2828

29-
All necessary packages and tools (SExtractor) are included in the `conda-sdt_env.yml` file.
29+
All necessary packages and tools (SExtractor) are listed in the `conda-spherex_sdt.yml` file.
3030

3131
To create a conda environment with the dependencies on your local machine use:
3232
```
33-
conda env create --f conda-sdt_conda.yml
33+
conda env create --f conda-spherex_sdt.yml
3434
```
3535

3636
Then, make the environment available in the list of kernels for your JupyterLab:
3737
```
38-
conda activate sdt_env
39-
python -m ipykernel install --user --name=sdt_env
38+
conda activate spherex_sdt
39+
python -m ipykernel install --user --name=spherex_sdt
4040
```
4141

4242
To use the environment in your Jupyter notebooks, either start JupyterLab in that environment by typing
4343

4444
```
45-
conda activate std_env
45+
conda activate spherex_sdt
4646
jupyter-lab
4747
```
4848

49-
or select the environment `sdt_env` in your Jupyter Notebook using the dropdown on the upper left.
49+
or select the environment `spherex_sdt` in your Jupyter Notebook using the dropdown on the upper left.
5050

5151
### On Fornax
5252

5353
Installing the conda environment on the [NASA Fornax Science Console](https://science.nasa.gov/astrophysics/programs/physics-of-the-cosmos/community/the-fornax-initiative/) needs slightly different steps. These can be reviewed in the documentation [create a new environment](https://docs.fornax.sciencecloud.nasa.gov/compute-environments/#create-new-env).
5454

55-
In order to install this specific conda environment on Fornax, the file name of the `yml` file specifically needs to be in the following format `conda-*.yml`. The `yml` file distributed here is already in that format (`conda-sdt_env.yml`). Once this is set, open a new terminal (click on the large "+" button right under the "File" menu tab) and type to following command _inside_ the same directory where the `yml` file is located:
55+
In order to install this specific conda environment on Fornax, the file name of the `yml` file specifically needs to be in the following format `conda-*.yml`. The `yml` file distributed here is already in that format (`conda-spherex_sdt.yml`). Once this is set, open a new terminal (click on the large "+" button right under the "File" menu tab) and type to following command _inside_ the same directory where the `yml` file is located:
5656
```
5757
setup-conda-env --user
5858
```
5959

6060
Note that we use the `--user` option here, which will keep the environment available for subsequent Fornax sessions.
6161

62-
To use the environment in your Jupyter notebooks on Fornax, directly select the environment `sdt_env` in your Jupyter Notebook using the dropdown on the upper left.
62+
To use the environment in your Jupyter notebooks on Fornax, directly select the environment `spherex_sdt` in your Jupyter Notebook using the dropdown on the upper left.

tutorials/spherex/spherex_sdt/conda-sdt_env.yml renamed to tutorials/spherex/spherex_source_discovery/conda-spherex_sdt.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: sdt_env
1+
name: spherex_sdt
22
channels:
33
- conda-forge
44
- defaults

tutorials/spherex/spherex_sdt/spx_sdt/__init__.py renamed to tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/__init__.py

File renamed without changes.

tutorials/spherex/spherex_sdt/spx_sdt/aperture_photometry.py renamed to tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/aperture_photometry.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
from tqdm import tqdm
2020

2121
# Local
22-
from spx_sdt.sdt_utils import get_exp_id
22+
from spherex_source_discovery_tool.sdt_utils import get_exp_id
2323

2424

2525
# Constants

tutorials/spherex/spherex_sdt/spx_sdt/bokeh_viz.py renamed to tutorials/spherex/spherex_source_discovery/spherex_source_discovery_tool/bokeh_viz.py

File renamed without changes.

0 commit comments

Comments
 (0)