Added note on Ic-broad being more similar to host-contaminated spectr…

…a to documentation
daniel-muthukrishna · Apr 3, 2019 · b218830 · b218830
1 parent bcb1fa6
commit b218830
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -191,9 +191,12 @@ This example automatically classifies 10 spectra. The last line plots the fifth
 
 6. API Usage
 ------------
-Notes: Sometimes inaccurate results if redshift is unknown.
+Note 1: Sometimes inaccurate results if redshift is unknown.
 
-6. Common Issues
+Note 2: In many cases DASH will classify a spectrum that has a lot of host-galaxy contamination as a Ic-broad type. Therefore, we suggest that users consider that the Ic-broad prediction is more likely to just be a host-contaminated spectrum.
+
+
+7. Common Issues
 ------------
 If you get an error like this:
     `ImportError: /lib64/libc.so.6: version 'GLIBC_2.17' not found`

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -114,3 +114,8 @@ Setting the filename in the format:
 where name is the 'name' of a supernova object (e.g. sn2002er) and 'ageIndex' is an integer index of the spectrum you wish to use from the open supernova catalog (e.g. 10).
 
 You may input this format into the graphical interface or as a string in the list of filenames in the python interface.
+
+
+Notes on performance
+++++++++++++++++++++
+In many cases DASH will classify a spectrum that has a lot of host-galaxy contamination as a Ic-broad type. Therefore, we suggest that users consider that the Ic-broad prediction is more likely to just be a host-contaminated spectrum.