docs: updated readme and added writeup

This commit is contained in:
2024-10-06 23:34:32 +02:00
parent 75f262460b
commit ad01943fad
2 changed files with 12 additions and 6 deletions

Binary file not shown.

View File

@@ -1,12 +1,18 @@
# Demo submission of team PL LTD DM for Nasa Space Apps Challenge 2024
Hi!
# Demo submission of team Space Needle PL LTD DM for Nasa Space Apps Challenge 2024
This is the git repository containing all code, reports and results created by us.
Below are instructions on how to interpret our results.
## How to use
0. Clone repo
1. Set up the requirements
3. Download and unzip the dataset provided by the hackathon
4. Run program
1. Set up the requirements (obspy, numpy, pandas, matplotlib, tqdm, tensorflow)
3. Download and unzip the [dataset](https://www.spaceappschallenge.org/nasa-space-apps-2024/challenges/seismic-detection-across-the-solar-system/?tab=resources&fbclid=IwZXh0bgNhZW0CMTEAAR3j3CCcr5S6dvvjn8JnJqXRUx5mk3yYQKNVWNuTHY_WwA6lto3eeege_wU_aem_7v3IO2ZeLyYC4Kcg_0-JHg) provided by the hackathon into the root of the repository
4. Run any of the pyhton files in the repository root or the the jupyter notebooks in `./preprocessed/lunar/data/`
## Results
- A writeup can be found in space_apps_2024_seismic_detection.zip
- Results against the training data can be found in training_report.json
- Estimated start of events in the testing data can be found in lunar_test_arrivals.json
- The results of the two ML algorithms implemented can be found in their respective jupyter notebooks