From 7c2b451a79f3fa6072c16830cda28885a3defbdb Mon Sep 17 00:00:00 2001 From: badgley Date: Wed, 6 Dec 2023 11:00:11 -0800 Subject: [PATCH] Add data access docs (#34) * Update .gitignore * Add data acccess doc --- .gitignore | 3 +++ docs/data-access.md | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 docs/data-access.md diff --git a/.gitignore b/.gitignore index b5cf56e..3e01ec0 100644 --- a/.gitignore +++ b/.gitignore @@ -159,3 +159,6 @@ cython_debug/ # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ offsets_db_data/_version.py + +.DS_Store +.idea diff --git a/docs/data-access.md b/docs/data-access.md new file mode 100644 index 0000000..fb5a1be --- /dev/null +++ b/docs/data-access.md @@ -0,0 +1,20 @@ +# Download OffsetsDB + +## CSV + +Download the latest version of OffsetsDB in csv: + +- [Download Credits](TK) +- [Download Projects](https://youtu.be/dQw4w9WgXcQ) + +## Parquet +Download the latest version of OffsetsDB in parquet: + +- [Download Credits](TK) +- [Download Projects](https://youtu.be/dQw4w9WgXcQ) + +You can also use parquet to access the full archive of OffsetsDB, representing the full history of the produciton of OffsetsDB: + +```python +# TK an example of how we want folks to work with archive data +```