instruction updated

abhi0395 · Aug 6, 2024 · ff7750d · ff7750d
1 parent cbf31ad
commit ff7750d
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 14 deletions.
diff --git a/data/datamodel.rst b/data/datamodel.rst
@@ -41,24 +41,29 @@ Run `qsoabsfind` with the required FITS file. If using a custom constant file, i
 
     qsoabsfind --input <path_to_input_fits_file> [--constant-file <path_to_constant_file>] --output <path_to_output_fits_file>
 
-Replace `<path_to_input_fits_file>` with the path to your input FITS file, `<path_to_constant_file>` with the path to your constant file (if using), and `<path_to_output_fits_file>` with the desired path for your output FITS file.
+Replace `<path_to_input_fits_file>` with the path to your input FITS file, `<path_to_constant_file>` with the path to your constant file (if using), and `<path_to_output_fits_file>` with the desired path for your output FITS file. For a quick example run you can run the module on `data/qso_test.fits`. 
 
 Output FITS File Structure
 --------------------------
 
-The **output** `fits file` will have the `ABSORBER` HDU, containing arrays such as:
+The **output** `fits file` will have two HDUs `ABSORBER` and `METADATA`:
+
+**ABSORBER** HDU will contain following structured data:
 
 - **INDEX_SPEC**: Index of quasar (can be used to read the RA, DEC, and Z of QSOs).
 - **Z_ABS**: Redshift of absorber.
-- **${METAL}_${line}_EW**: Rest-frame equivalent widths (EWs) of absorber lines (e.g., MgII 2796, 2803 or CIV 1548, 1550) in Angstroms.
-- **${METAL}_${line}_EW_ERROR**: Uncertainties in rest-frame EWs of absorber lines in Angstroms.
+- **${METAL}_${LINE}_EW**: Rest-frame equivalent widths (EWs) of absorber lines (e.g., MgII 2796, 2803 or CIV 1548, 1550) in Angstroms.
+- **${METAL}_${LINE}_EW_ERROR**: Uncertainties in rest-frame EWs of absorber lines in Angstroms.
 - **Z_ABS_ERR**: Measured error in the redshift of the absorber.
 - **GAUSS_FIT**: Rest-frame fitting parameters of double Gaussian to the absorber doublet (the width can be used to measure the velocity dispersion).
 - **GAUSS_FIT_STD**: Uncertainties in rest-frame fitting parameters of double Gaussian to the absorber doublet.
-- **SN_${METAL}_${line}**: Signal-to-noise ratio of the lines.
-- **${metal}_EW_TOTAL**: Total EW of the lines in Angstroms.
-- **${metal}_EW_TOTAL_ERROR**: Uncertainties in total EW of the lines in Angstroms.
+- **SN_${METAL}_${LINE}**: Signal-to-noise ratio of the lines.
+- **${METAL}_EW_TOTAL**: Total EW of the lines in Angstroms.
+- **${METAL}_EW_TOTAL_ERROR**: Uncertainties in total EW of the lines in Angstroms.
+
+**METADATA** HDU will contain every metadata (corresponding to each absorber) that is available in input spectra file.
+
 
-Thanks,
-Abhijeet Anand
-Lawrence Berkeley National Lab
+| Thanks,
+| Abhijeet Anand
+| Lawrence Berkeley National Lab
diff --git a/qsoabsfind/parallel_convolution.py b/qsoabsfind/parallel_convolution.py
@@ -157,10 +157,9 @@ def main():
 
     # Set the environment variable for the constants file
     if args.constant_file:
-        if not os.path.isabs(args.constant_file):
-            args.constant_file = os.path.abspath(os.path.join(os.getcwd(), args.constant_file))
-            os.environ['QSO_CONSTANTS_FILE'] = args.constant_file
-            print(f"INFO: Using user-provided constants from: {args.constant_file}")
+        print(f"INFO: Using user-provided constants from: {os.path.abspath(args.constant_file)}")
+        print(f'INFO: Overwriting QSO_CONSTANTS_FILE variable with this path')
+        os.environ['QSO_CONSTANTS_FILE'] = os.path.abspath(args.constant_file)
 
     print(f"INFO: QSO_CONSTANTS_FILE: {os.environ['QSO_CONSTANTS_FILE']}")
     # set the new constants