Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export information documentation #25

Merged
merged 2 commits into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions docs/source/user_guide/export_locations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
Working with Export Locations - Drive vs. Cloud
====================================================
EEDL works by using Earth Engine's built in export mechanisms, which can
send exported images either to Google Drive or to a Google Cloud storage
bucket. In order for EEDL to finish processing exports - that is, for it
to handle downloading and mosaicking images for you, you'll need to
either set up a Google Cloud storage bucket, configured for public access,
or install the Google Drive client on your computer. The package does not
currently use either the Google Cloud APIs or Google Drive APIs, avoiding
the need for authentication, but presenting some limits and requirements on
use.

Google Drive Exports
------------------------

.. note::
Key takeaway: If you can run the Google Drive client on the same
computer as you're running EEDL and have enough space in Drive
for your exports, Drive exports may be a good option for you.

Key Considerations
_____________________
Linux users may need to use the Cloud export option because available options
for accessing Drive folders on Linux are lacking. If you have Drive set up as a directory
on your computer though, you can use this format.

EEDL *does* automatically delete files it processes out of Google Drive, but
it only moves the files to your Drive Trash, which you can only clear
in their web interface. Your storage will continue being occupied for 30 days, until
Drive automatically deletes the files from your Drive Trash, unless you manually
go in and empty your Trash within the Google Drive web interface. For especially
large exports/sets of exports, you may need to clear your trash midway through,
depending on your available Drive storage.

This method is private - files aren't shared or available to anyone else.

Google Cloud Exports
------------------------

Key Considerations
______________________
Exports are public and accessed via public URL structure. Don't export
sensitive information via Cloud. If you want an option to access private
buckets, please get in touch about submitting a pull request.
Our client does *not* delete files automatically as it does not carry
permissions to perform that operation (want it to be able to do that?
Get in touch about submitting a pull request with code for that).
We recommended setting a bucket lifecycle setting that automatically deletes
files after 24 hours to save on costs and not manage files. EEDL will
automatically download files within minutes in most cases.

While Earth Engine's exports *are* publicly available and linkable here,
EEDL does not upload any derived products (mosaics or zonal stats) back
to the bucket, so those do not become public.

.. note::
Key takeaway: If you can't run the Google Drive client, lack space
in Drive, want to bill export storage to a Cloud project, want
the files available externally, or want the most reliable
export method, using Google Cloud exports may be a good option
for you.
2 changes: 2 additions & 0 deletions docs/source/user_guide/getting_started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Getting Started with EEDL
============================
6 changes: 3 additions & 3 deletions docs/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@


==============
What is eedl?
What is EEDL?
==============

eedl combines the functionality of what normally would take several packages into one. This makes working with eedl easier and more consistent that when working with other modules.

====================
How to install eedl
How to install EEDL
====================

Currently eedl can only be installed from the `GitHub repository`_. Distribution through PyPI and Conda-Forge are, hopefully, soon to come.
Currently EEDL can only be installed from the `GitHub repository`_. Distribution through PyPI (i.e. via pip) and Conda Forge are coming soon.

.. _GitHub repository: https://github.com/water3d/eedl/