Expose options to CLI - Githubissues

emissions-api / sentinel5dl

Sentinel-5(P) Downloader

https://sentinel5dl.emissions-api.org

MIT License

12 stars 8 forks source link

Expose options to CLI #1

Closed lkiesow closed 4 years ago

lkiesow commented 4 years ago

Right now, the CLI tool has a bunch of hardcoded search parameters used for downloading Sentinel-5p data files. While this works for testing purposes, it would be quite nice to evolve this into an actual useful command-line tool by simply exposing a fea of the search options.

The hard-coded options can be found here:

https://github.com/emissions-api/sentinel5dl/blob/3921a5ebcdc64d38dc9e01ed728b0dd8effbddd8/sentinel5dl/__main__.py#L16-L25

Maybe we could use something like argparse to provide the search options via the command line.

cfletemier commented 4 years ago

I'd like to work on this if that's ok.

lkiesow commented 4 years ago

Sure, go ahead. That would be great.

On October 6, 2019 2:35:09 AM GMT+02:00, Cfletemier notifications@github.com wrote:

I'd like to work on this if that's ok.

cfletemier commented 4 years ago

How do we want to handle the polygon arguments? We could require a 5 element tuple containing 2 element tuples each with the one included now as an example or default. It'll make for a large command line command but it'll work.

lkiesow commented 4 years ago

Some alternatives:

The simplest way would be to just require the user to provide a polygon in WKT form which is what the API requires.
A simple and relatively user-friendly way would be to just ask for two coordinates which could be the top-left and bottom-right coordinates of a rectangle (e.g. --geoframe=lon1,lat1,lon2,lat2). From that, it would be easy to construct a polygon. This would probably serve most purposes.
Finally, we could ask for a GeoJSON containing a polygon. That way, we could easily provide complex shapes but it is also more complex and probably means more dependencies. Not sure if that is what we necessarily want since this is mainly meant as a library.

Anyway, I'll leave the decision up to you.

cfletemier commented 4 years ago

Makes sense, your first suggestion is what I was lookin at when mulling this over so I'll go with that and then add that link in help text. Thanks!

lkiesow commented 4 years ago

Hey @cfletemier, how are things going? Are you making progress with this? Do you need any help?

cfletemier commented 4 years ago

@lkiesow I am making progress, just been an eventful week. I should have a PR for this soon.

lkiesow commented 4 years ago

No problem, thanks for the update. Let us know if you run into any problems.

cfletemier commented 4 years ago

@lkiesow please let me know if this is sufficient or if more validation is needed. I'll be happy to revise!