Skip to content

Commit

Permalink
Code formatting and readme updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
petebunting committed Dec 4, 2024
1 parent 195c833 commit de70c24
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A module with tools for supporting the use of the Google Earth Engine Python API and reducing work for repetitive or common tasks.

Specifically, these tools are mainly focused on accessing EO datasets and applying relevant valid data masks etc.

## Install using pip

`pip install .`
15 changes: 15 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# PB GEE Tools Examples

These notebooks are intended to provide documentation but also reference
examples in how to use pb_gee_tools.


These notebooks are intended to be run within colab (https://colab.research.google.com).
The easiest ways to run these notebooks is to download them and save them to your
google drive and then open then in colab from there.


To specify the region of interest for these notebooks you need to pass a file path
to a vector layer (any format than geopandas reads, such as an ESRI shapefile)
and then bounding box of all the geometries with the vector layer will be used
as the region of interest unless otherwise stated in the notebook.
2 changes: 2 additions & 0 deletions pb_gee_tools/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ def create_year_month_start_end_lst(

return out_year_mnt_lst


def create_year_month_n_months_lst(
start_year: int, start_month: int, n_months: int
) -> List[Tuple[int, int]]:
Expand Down Expand Up @@ -125,6 +126,7 @@ def create_year_month_n_months_lst(

return out_year_mnt_lst


def find_month_end_date(year: int, month: int) -> int:
"""
A function which returns the date of the last day of the month.
Expand Down

0 comments on commit de70c24

Please sign in to comment.