Skip to content

Commit

Permalink
Merge pull request #381 from Allonck/updateDocs
Browse files Browse the repository at this point in the history
Remove 'o' prefix
  • Loading branch information
simontorres authored Mar 4, 2024
2 parents 8806796 + c117421 commit 865c4cd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
7 changes: 6 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
version: 2

build:
os: ubuntu-lts-latest
tools:
python: "mambaforge-22.9"


sphinx:
configuration: docs/conf.py

formats: all

python:
version: 3.8
install:
- method: pip
path: .
Expand Down
10 changes: 3 additions & 7 deletions docs/_file_prefixes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,15 @@ So what does all those letter mean? Here is a table to explain it.

So, for an original file named ``file.fits``:

``o_file.fits``

Means the file have been overscan corrected while

``eczsto_file.fits``
``eczst_file.fits``

Means the spectrum has been extracted to a 1D file but the file has not been
flat fielded (``f`` missing).

Ideally after running ``redccd`` the file should be named:

``cfzsto_file.fits``
``cfzst_file.fits``

And after running ``redspec``:

``wecfzsto_file.fits``
``wecfzst_file.fits``

0 comments on commit 865c4cd

Please sign in to comment.