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

[Joss review] Add simple example #4

Closed
rmsare opened this issue May 28, 2020 · 5 comments
Closed

[Joss review] Add simple example #4

rmsare opened this issue May 28, 2020 · 5 comments

Comments

@rmsare
Copy link

rmsare commented May 28, 2020

The detectree-example repository does a very nice job of walking users through the core methods implemented in detectree and several options for sampling/grouping the training data to yield useful classifiers given a variety of scenes.

It is missing an example use case, though. Something as simple as taking imagery from a particular area, training and applying the tree detection method, and summarizing the tile-level percentage of tree cover (or other useful and interesting statistics).

A full end-to-end example would be best. using just high level API calls. This would give a potential user an easy entry point for their own work.

This example workflow could also be added to a "Using detectree" section of the ReadTheDocs site - a user could skim it to quickly get a sense of how the API or CLI could be used in practice.

JOSS review

@rmsare
Copy link
Author

rmsare commented May 28, 2020

Also, you provided a Makefile for a fully reproducible workflow. What a great idea.

@martibosch
Copy link
Owner

I have added a full end-to-end example to compute a tree canopy map for the Aussersihl district in Zurich in 7533b0. It is a small spatial extent so that the whole notebook runs in 20 minutes in my laptop.

The computation of some statistics could be appended to the notebook as well, but I find that predicting the canopy map and dumping it to a single GeoTIFF file already provides a good example of the API of DetecTree.

Both the README and ReadTheDocs site link to the example repository, which now features the new notebook. But we can add an explicit link to it if you find that it is more appropriate. In any case, as soon as we have a proper example of an academic paper using DetecTree, I will add it to the README and ReadTheDocs site as well. Actually, we have submitted a paper in which we use DetecTree to obtain a canopy map (the one in the lausanne-tree-canopy repository) used to evaluate urban heat islands in Lausanne, yet I do not know when we will have a proper citation format for it. I thus hope that in the meantime, the new notebook illustrates an example use case well enough.

@rmsare
Copy link
Author

rmsare commented Jun 11, 2020

Thanks - the new example looks good and it's easy to follow. I think adding an explicit link in the README would be useful, so users don't have to work to find it.

@martibosch
Copy link
Owner

martibosch commented Jun 11, 2020

Alright then - I have added the links to the new example in the README and the documentation index in 7f667a

@rmsare
Copy link
Author

rmsare commented Jun 11, 2020

Excellent - looks good to me

@rmsare rmsare closed this as completed Jun 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants