clean up readme tests data directory

- remove unused data files - update README to list what tests or using what files
dirac-institute · Dec 17, 2023 · e6ca313 · e6ca313
1 parent 084172a
commit e6ca313
Show file tree

Hide file tree

Showing 5 changed files with 154 additions and 8,647 deletions.
diff --git a/tests/data/README.md b/tests/data/README.md
@@ -1,118 +1,183 @@
 # TEST FILES/DATA README
 
 The data within this folder is used by the unit tests, located in .../tests/*/*.
+In some cases its the location of the given file being used in the test rather than its contents.
 
 ## Files:
 
 **baseline_10klines_2.0.db**  
 Small (10k lines) version of pointing database located at /demo/baseline_v2.0_1yr.db.  
 Used by:  
+- test_combined_data_reading.py
 - test_createResultsSQLDatabase.py
 - test_makeConfigPP.py  
-- test_makeConfigOIF.py  
-- test_makeMultiConfigOif.py  
+- test_makeConfigOIF.py   
 - test_makeSLURMscript.py  
+- test_PPCommandLineParser.py
+- test_PPConfigParser.py
+- test_PPMatchPointingToObservations.py
 - test_PPReadAllInput.py  
 - test_PPReadPointingDatabase.py
 
-**config_test\*.ini**  
-Example OIF config files with standardised names.  
-Used by:  
-- test_makeMultiConfigOIF.py  
-- test_makeSLURMscript.py
-
 **detectors_corners.csv**  
 Corners of the LSST camera footprint.  
 Used by:  
 - test_makeConfigPP.py  
+- test_PPApplyFOVFilter.py
+- test_PPConfigParser.py
 - test_PPFootprintFilter.py
 
-**lsst-total-r.dat**  
-Throughput of LSST per wavelength.  
-Used by:  
-- /sorcha/lsstcomet/tests/test_model.py
+**orbit_test_files/orbit_bcart.csv**
+Barycentric cartesian orbit format test input file
+Used by:
+-test_OrbitAuxReader.py
 
-**makeConfigOIF_*.ini**  
-Example OIF config files.  
-Used by:  
-- test_makeConfigOIF.py
+**orbit_test_files/orbit_bcom.csv**
+Barycentric cometary orbit format test input file
+Used by:
+-test_OrbitAuxReader.py
 
-**makeConfigPP_ini**  
-Example SSPP config file.  
-Used by:  
-- test_makeConfigPP.py
+**orbit_test_files/orbit_bkep.csv**
+Barycentric Keplarian orbit format test input file
+Used by:
+-test_OrbitAuxReader.py
+
+**orbit_test_files/orbit_cart.csv**
+Heliocentric cartesian orbit format test input file
+Used by:
+-test_OrbitAuxReader.py
+
+**orbit_cart_wrong_cols.csv**
+Heliocentric cartesian orbit format test input file with incorrect headers
+Used by:
+-test_OrbitAuxReader.py
+
+**orbit_test_files/orbit_com.csv**
+Heliocentric cometary orbit format test input file
+Used by:
+-test_OrbitAuxReader.py
+
+**orbit_test_files.orbit_com_wrong_cols.csv**
+Heliocentric cometary orbit format test input file with incorrect columns
+Used by:
+-test_OrbitAuxReader.py
+
+**orbit_test_files/orbit_extra_cols.csv**
+Heliocentric cartiesian orbit format test input file with extra columns
+Used by:
+-test_OrbitAuxReader.py
 
-**makeMultiConfigOIF_test\*.ini**  
-Example OIF config files.  
+**orbit_test_files/orbit_kep.csv**
+Heliocentric Keplarian orbit format test input file
+Used by:
+-test_OrbitAuxReader.py
+
+**orbit_test_files/orbit_kep_wrong_cols.csv**
+Heliocentric Keplarian orbit format test input file with incorrect columns
+Used by:
+-test_OrbitAuxReader.py
+
+**orbit_test_files/orbit_unknown_format.csv**
+Orbit input file with unallowed orbit format 
+Used by:
+-test_OrbitAuxReader.py
+
+
+**makeConfigPP_config.ini**  
+Example Sorcha config file.  
 Used by:  
-- test_makeMultiConfigOIF.py
+- test_makeConfigPP.py
 
 **makeSLURMscript_*.sh**  
 Example SLURM scripts.  
 Used by:  
 - test_makeSLURMscript.py
 
-**oif_temptest.csv**  
-Example OIF output with standardised name.  
-Used by:  
-- test_createTemporaryDatabases.py
-
-**oiftestoutput_header.csv**
-Example OIF output with extended header.  
-Used by:  
-- test_PPReadOif.py
+**ObsCodes_test.json**
+Example MPC-style observatory codes files
+Used by:
+- test_simulation_parsing.py
 
 **oiftestoutput.csv**  
-Example OIF output in .csv format.  
+Example ephemeris output in .csv format.  
 Used by:  
-- test_PPReadOif.py
+- test_CSVReader.py
+- test_OIFReader.py
+
+**oiftestoutput.h5**  
+Example ephemeris output, in HDF5 format
+Used by:
+- test_OIFReader.py
+- tests/readers/test_HDF5Reader.py
 
 **oiftestoutput.txt**  
-Example OIF output, whitespace-separated.  
+Example ephemeris output, whitespace-separated.  
 Used by:  
-- test_createResultsSQLDatabase.py  
+- test_CombinedDataReader.py
+- test_createResultsSQLDatabase.py 
+- test_CSVReader.py 
+- test_PPJoinEphemeridesAndOrbits.py
 - test_makeConfigOIF.py  
+- test_makeSLURMscript.py
+- test_OIFReader.py
+- test_PPCheckInputObjectIDs.py
+- test_PPCommandLineParser.py
 - test_PPJoinEphemeridesAndOrbits.py  
 - test_PPReadEphemerides.py  
-- test_PPReadOif.py
 
-**orbits_test\*.txt**  
+**oiftestoutput_comment.csv**  
+Example ephemeris output in .csv format when the columns 
+are not the start of row 0 but later in the file after a header
+Used by:
+- tests/readers/test_CSVReader.py
+
+**orbits_test1.txt**  
 Example orbits files with standardised names.  
 Used by:  
-- test_makeMultiConfigOIf.py  
 - test_makeSLURMscript.py
 
-**params_test\*.txt**  
-Example physical parameters files with standardised names.
+**orbits_test2.txt**  
+Example orbits files with standardised names. 
 Used by:  
-- test_makeMultiConfigOIf.py  
-- test_makeSLURMscript.py
+- test_makeSLURMscript.py 
+
+**params_test1.txt**  
+Example physical parameters files with standardised names.
+Used by:   
+
+**params_test2.txt**  
+Example physical parameters files with standardised names.
+Used by:   
 
 **PPReadAllInput_oif.txt**  
 Example OIF output, compatible with pointing database.  
 Used by:  
-- test_PPReadAllInput.py
+- test_combined_data_reading.py
+- test_CombinedDataReader.py
 
 **PPReadAllInput_orbits.des**  
 Example orbits file, compatible with pointing database.  
 Used by:  
-- test_PPReadAllInput.py
+- test_combined_data_reading.py
+- test_CombinedDataReader.py
+- test_ephemeris_generation.py
 
 **PPReadAllInput_params.txt**  
 Example physical parameters file, compatible with pointing databse.  
 Used by:  
-- test_PPReadAllInput.py
+- test_combined_data_reading.py
+- test_CombinedDataReader.py
+- test_ephemeris_generation.py
 
 **PPReadOrbitFile_bad.txt**  
 Example orbits file with bad column headers.  
 Used by:  
-- test_PPReadOrbitFile.py
+- test_OrbitAuxReader.py
 
 **sqlresults.db**  
-Example output in SQL database form.  
+Example sorcha output in SQL database form.  
 Used by:  
-- test_createResultsSQLDatabase.py  
-- test_PPCommandLineParser
+- test_createResultsSQLDatabase.py
 
 **test_input_fullobs.csv**  
 Example of full dataframe of observations created by sorcha.py.  
@@ -123,62 +188,74 @@ Used by:
 - test_PPDropObservations.py  
 - test_PPFootprintFilter.py  
 - test_PPLinkingFilter.py
+- test_PPOutput.py
+- test_PPRandomizeMeasurements.py
 
 **test_PPConfig.ini**  
-Example SSPP config file.  
+Test Sorcha config file.  
 Used by:  
-- test_makeSLURMscript.py  
-- test_PPCommandLineParser.py  
-- test_PPConfigParser.py  
-- test_PPOutput.py  
-- test_PPRandomizeMeasurements.py 
-- test_PPReadAllInput.py
+- test_combined_data_reading.py
+- test_makeSLURMscript.py
+- test_PPCommandLineParser.py
+
 
 **test_PPPrintConfigsToLog.txt**  
 Example of an SSPP log file.  
 Used by:  
-- PPPrintConfigsToLog.py
+- test_PPConfigParser.py
 
 **testcolour.csv**  
 Example physical parameters file, .csv format.  
 Used by:  
-- test_PPreadPhysicalParameters.py
+- test_CSVReader.py
 
 **testcolour.txt**  
 Example physical parameters file, whitespace-separated.  
 Used by:  
-- test_createResultsSQLDatabase.py  
-- test_PPCheckInputObjectIDs.py  
-- test_PPCommandLineParser.py  
-- test_PPConfigParser.py  
-- test_PPGetMainFilterAndColourOffsets.py  
-- test_PPJoinEphemeridesAndParameters.py  
-- test_PPReadOif.py  
-- test_PPReadPhysicalParameters.py  
-- test_PPReadTemporaryEphemerisDatabase.py
+- test_createResultsSQLDatabase.py
+- test_CSVReader.py
+- test_OIFReader.py
+- test_PPCheckInputObjectIDs.py
+- test_PPCommandLineParser.py
+- test_PPConfigParser.py
+- test_PPGetMainFilterAndColourOffsets.py
+- test_PPJoinEphemeridesAndParameters.py
 
 **testcomet.txt**  
 Example cometary parameters file.  
 Used by:  
-- test_PPReadCometaryParameters.py
+- test_CSVReader.py
+- test_PPCommandLineParser.py
+
+**test_ephem_config.ini**
+Example Sorcha config file with ephemeris keywords.
+Used by:
+ - test_ephemeris_generation.py
 
 **testobs_clean.csv**  
 Reduced version of test_input_fullobs.csv.  
 Used by:  
 - test_createResultsSQLDatabase.py
 
+**testdb_PPIntermDB.db**
+SQL database of epehemeris output. Functionality no longer used but kept in for
+possible future software development. 
+Used by:  
+- test_DatabaseReader.py
+
 **testorb.csv**  
 Example orbits file, .csv format.  
 Used by:  
-- test_PPReadOrbitFile.py
+- test_CSVReader.py
+- test_OrbitAuxReader.py
 
 **testorb.des**  
 Example orbits file, whitespace-separated.  
-Used by:  
-- test_createResultsSQLDatabase.py  
-- test_makeConfigOIF.py  
-- test_makeMultiConfigOIf.py  
-- test_PPCheckInputObjectIDs.py  
-- test_PPCommandLineParser.py  
-- test_PPConfigParser.py  
+Used by: 
+- test_createResultsSQLDatabase.py
+- test_CSVReader.py
+- test_OrbitAuxReader.py 
+- test_PPCheckInputObjectIDs.py
+- test_PPCommandLineParser.py
+- test_PPConfigParser.py
 - test_PPJoinEphemeridesAndOrbits.py