Skip to content

Commit a5178a4

Browse files
committed
Updated sqltutorial images and fixed some typos.
1 parent 62b52c8 commit a5178a4

7 files changed

Lines changed: 8 additions & 8 deletions
208 KB
Loading
94 KB
Loading
3.76 KB
Loading
Binary file not shown.
899 KB
Loading

TUTORIAL/tutorial_readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For full installation instructions, refer to the [`README.md`](https://github.co
1010
pip install .
1111
```
1212

13-
You can check if your installation was successful by starting a python session and importing the pacakge:
13+
You can check if your installation was successful by starting a python session and importing the package:
1414

1515
```python
1616
python
@@ -30,7 +30,7 @@ The [Filename Checker Guide](https://github.com/spacetelescope/mast_contributor_
3030

3131
The [`tutorial-data/`](https://github.com/spacetelescope/mast_contributor_tools/blob/main/TUTORIAL/tutorial-data/) folder included in this tutorial contains several example files that you can use for testing. Take a look in that folder and familiarize yourself with its contents! This folder contains 3 different files, for a hypothetical HLSP named "mct-tutorial".
3232

33-
There are three different fake fits files containing spectra for different hypothetical galaixes:
33+
There are three different fake fits files containing spectra for different hypothetical galaxies:
3434

3535
- `hlsp_mct-tutorial_jwst_nirspec_galaxy1_multi_v1_spec.fits`
3636
- `hlsp_mct-tutorial_jwst_nirspec_galaxy2_multi_v1_spec.fits`
@@ -86,7 +86,7 @@ Next, here's an example of a file name which fails validation. HLSP filenames ar
8686
mct check_filename HLSP_mct-tutorial_JWST_nirspec_GALAXY1_multi_v1_spec.fits
8787
```
8888

89-
You should see that this filename will recieve:
89+
You should see that this filename will receive:
9090

9191
```
9292
Final Score: FAIL
@@ -97,7 +97,7 @@ But why did it fail? You can use the verbose flag (`-v`) to investigate and lear
9797
```shell
9898
mct check_filename -v HLSP_mct-tutorial_JWST_nirspec_GALAXY1_multi_v1_spec.fits
9999
```
100-
This will print out a lot more information than the previous command, but specifically, it will show that this filename failed because the "`HLSP`", "`JWST`", and "`GALAXY1`" parts recieved a `capitalization_score: fail`.
100+
This will print out a lot more information than the previous command, but specifically, it will show that this filename failed because the "`HLSP`", "`JWST`", and "`GALAXY1`" parts received a `capitalization_score: fail`.
101101

102102
## Step 4: Checking multiple file names at once
103103

@@ -130,7 +130,7 @@ Use this command to run the filename checker against everything in the [`tutoria
130130
mct check_filenames mct-tutorial --directory='tutorial-data/'
131131
```
132132

133-
You should receieve an output message that 5 files were checked, and that all files passed!
133+
You should receive an output message that 5 files were checked, and that all files passed!
134134

135135

136136
### Step 4c: Check all file names from a list
@@ -143,7 +143,7 @@ This command reads in a list from the `tutorial_file_list.txt` file, and checks
143143
mct check_filenames mct-tutorial --from_file='tutorial_file_list.txt'
144144
```
145145

146-
You should receieve an output message that 8 files were checked, and that all files passed!
146+
You should receive an output message that 8 files were checked, and that all files passed!
147147

148148

149149
### Step 4d. Selecting or Excluding files

docs/filename_check_readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,6 @@ The results are written out in a database file (named `results_<proj-id>.db`). T
149149

150150
* filename - file path, name, number of fields, status
151151
* fields - field attributes for each filename, and evaluation
152-
* potential_problems (view) - selects all instances where an 'fail', or 'needs review' value was identified. Non-fatal warnings and unrecognized values are not always real problems; these will be reviewed by MAST staff.
152+
* problems (view) - selects all instances where an 'fail', or 'needs review' value was identified. Non-fatal warnings and unrecognized values are not always real problems; these will be reviewed by MAST staff.
153153

154-
The **potential_problems** view may be filtered to select only fatal errors.
154+
The **problems** view may be filtered to select only fatal errors.

0 commit comments

Comments
 (0)