Initial commit

.gitattributes

@@ -57,3 +57,5 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 # Video files - compressed
 *.mp4 filter=lfs diff=lfs merge=lfs -text
 *.webm filter=lfs diff=lfs merge=lfs -text
+
+*.csv filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1 @@
+s3_data

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Charlie Fish
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,3 +1,35 @@
 ---
 license: mit
 ---
+
+# AirportStatusBot Data
+
+This Hugging Face Dataset includes data released by my [AirportStatusBot](https://github.com/fishcharlie/AirportStatusBot).
+
+## Data
+
+#### `data/faa/faa_xml_data.csv`
+
+This is a CSV file that contains the [raw data from the FAA](https://nasstatus.faa.gov/api/airport-status-information) that AirportStatusBot has captured. There is no header in this file, and each line/row is a string of XML data directly from the FAA.
+
+There are no duplicates in this file, and they are sorted by the `Update_Time` field in the XML data.
+
+## Other Files
+
+#### `data_processing_notebook.ipynb`
+
+This is a Jupyter Notebook that I used to process the raw XML data into a CSV file. If you have access to the RAW data that AirportStatusBot has captured, you can use this notebook to process the data into the CSV file (`data/faa/faa_xml_data.csv`).
+
+## Other Notes
+
+- There is no guarantee that this data is complete. There may be missing data. However I'm fairly confident that the data provided is as accurate as the FAA provides.
+- The date range of data included is currently from 2023-12-17 to 2024-12-24. If you would like to see data more recent than this, please feel free to reach out to me.
+- I would **love** to hear about how you use this data. Please reach out to me and let me know how you're using it!
+
+## Contact
+
+If you have any questions or concerns, please feel free to [contact me](https://charlie.fish/contact).
+
+## License
+
+[MIT](LICENSE)

data/faa/faa_xml_data.csv

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5faa8a23fc1f04a069da5de3b8e9df7c33bc2595973ad865535aed36952946fd
+size 37414794

data_processing_notebook.ipynb

@@ -0,0 +1,104 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Data Processing Notebook\n",
+    "\n",
+    "The purpose of this notebook is to help me process the RAW S3 data into the right format to upload to Hugging Face."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Import dependencies\n",
+    "import os\n",
+    "from datetime import datetime"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Make directory called `data/faa` if it doesn't already exist.\n",
+    "if not os.path.exists('data/faa'):\n",
+    "\tos.makedirs('data/faa')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# For each file in `s3_data` directory\n",
+    "xml_data_strings = []\n",
+    "for file in os.listdir('s3_data'):\n",
+    "\t# If file doesn't end in `.txt`, continue\n",
+    "\tif not file.endswith('.txt'):\n",
+    "\t\tcontinue\n",
+    "\t# Open the file in read mode\n",
+    "\twith open(f's3_data/{file}', 'r') as f:\n",
+    "\t\t# Read the file content\n",
+    "\t\tcontent = f.read()\n",
+    "\n",
+    "\t\t# Split the content by the separator\n",
+    "\t\tparts = content.split('<><><><><>')\n",
+    "\n",
+    "\t\txml_data = ''\n",
+    "\t\t# Get the XML data as a string\n",
+    "\t\tif len(parts) == 1:\n",
+    "\t\t\txml_data_strings.append(parts[0].split('---')[1].strip())\n",
+    "\t\telse:\n",
+    "\t\t\tfor part in parts:\n",
+    "\t\t\t\txml_data_strings.append(part.split('---')[1].strip())\n",
+    "\n",
+    "# Delete any duplicate strings in the xml_data_strings list\n",
+    "xml_data_strings = list(set(xml_data_strings))\n",
+    "\n",
+    "# Sort the XML data strings by the `<AIRPORT_STATUS_INFORMATION><Update_Time>Wed Jul 10 17:18:22 2024 GMT</Update_Time>` date\n",
+    "def extract_update_time(xml_string):\n",
+    "\tstart = xml_string.find(\"<Update_Time>\") + len(\"<Update_Time>\")\n",
+    "\tend = xml_string.find(\"</Update_Time>\")\n",
+    "\tdate_str = xml_string[start:end].strip()\n",
+    "\treturn datetime.strptime(date_str, \"%a %b %d %H:%M:%S %Y %Z\")\n",
+    "xml_data_strings.sort(key=extract_update_time)\n",
+    "\n",
+    "# Write the XML data to a single file in the `data/faa` directory with each XML data string on a new line\n",
+    "with open('data/faa/faa_xml_data.csv', 'w') as f:\n",
+    "\tfor xml_data in xml_data_strings:\n",
+    "\t\tf.write(xml_data + '\\n')\n",
+    "\n",
+    "# Delete the xml_data_strings list to free up memory\n",
+    "del xml_data_strings"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.0"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}