Skip to content

Commit

Permalink
Changelog readme and version
Browse files Browse the repository at this point in the history
  • Loading branch information
fbalaban committed Jun 26, 2024
1 parent 059472d commit 63bc6fb
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
5 changes: 3 additions & 2 deletions noa-harvester/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.5.0] - 2024-06-26
### Added
- Introduce STAC search for S2 S2A COGs from earth search collection (#23)
- Introduce STAC search/download for Element84 COGs collections (#23)

## [0.4.0] - 2024-05-14

### Added
- Functionality before the creation of this CHANGELOG (#4, #14, #19)
- Integration of earthaccess (NASA) and cdsetool libs for Copernicus (ESA) asset downloads (#6, #11)
Expand Down
26 changes: 21 additions & 5 deletions noa-harvester/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ It is a simple cli wrapper of the following (to be expanded) libraries:
- CDSETool (https://github.com/SDFIdk/CDSETool)
- earthaccess (https://github.com/nsidc/earthaccess)

and common STAC API functionality, for accessing public catalogs:
- Element84 COG STAC collection (earthsearch - https://github.com/Element84/earth-search)

It can be used as a standalone cli application or be built in a Docker container.

# Using the processor
Expand Down Expand Up @@ -77,7 +80,7 @@ Available commands are:
- describe (Copernicus only) - Describe collection's available query fields

The config file *should* be placed inside `eoProcessors/noa-harvester/config`, but of course you could use any path.
The optional shapefile argument can be used in the end, to draw the bounding box from shapefile information (`.shp` for the shape and `.prj` for the projection information). Please note that you should use the common file base name for both files as the argument. E.g. for `weird_area.shp` and `weird_area.prj`, use `weird_area` as the argument)
The optional shapefile argument can be used in the end, to draw the bounding box from shapefile information (`.shp` for the shape and `.prj` for the projection information). Please note that you should use the common file base name for both files as the argument. E.g. for `weird_area.shp` and `weird_area.prj`, use `weird_area` as the argument

Please check the [Config](#Config-file-parameters) section regarding config file specification.

Expand Down Expand Up @@ -149,26 +152,39 @@ Take a look at the sample config.json.
{
"maxRecords": "100",
"startDate": "2024-01-06",
.....
.....
}
}
},
{
"provider": "earthdata",
"collection": "MODIS",
"search_terms":
{
"maxRecords": "100",
"startDate": "2019-01-01",
.....
.....
}
},
{
"provider": "earthsearch",
"version": "v0",
"collection": "sentinel-s2-l2a-cogs",
"search_terms":
{
"maxRecords": "100",
"startDate": "2023-05-01",
"cloud_cover_lt": 90,
.....
}
}
}
]
```
As the top level keys, you have to introduce the provider and collection names. You can include as many sources as needed.

Please refer to
- Copernicus [OData API] for available collections and query keys
- Earthdata and [earthaccess] python library for available EarthData collections, product type short names and query terms.
- Element84 COG STAC collection (earthsearch - https://github.com/Element84/earth-search)

## Cli options

Expand Down
2 changes: 1 addition & 1 deletion noa-harvester/noaharvester/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# pylint:disable=missing-module-docstring
__version__ = "0.4.0"
__version__ = "0.5.0"

0 comments on commit 63bc6fb

Please sign in to comment.