Add data access docs (#34)

* Update .gitignore * Add data acccess doc
carbonplan · Dec 6, 2023 · 7c2b451 · 7c2b451
1 parent 1c2d387
commit 7c2b451
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git 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
@@ -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
+```