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

Add short example notebooks #48

Closed
callumrollo opened this issue Mar 17, 2021 · 8 comments
Closed

Add short example notebooks #48

callumrollo opened this issue Mar 17, 2021 · 8 comments

Comments

@callumrollo
Copy link
Member

Rationale
The only current notebook is huge and overwhelming. A set of small notebooks for specific, common tasks would be much more appealing to the casually interested scientist

How the user would call this functionality.
Ideally by clicking a button in the README that launches a Binder notebook e.g. "Intro to glider tools" or "correct for chlorophyll quenching"

Outline what is needed for this feature
Should write notebooks for features that

  • Are applicable to many users
  • Have a stable implementation
  • Can be easily binderised

I think porting the package to conda-forge (#45) will make this easier. In my experience, binder prefers conda packages to pip.

This is an issue from the #46 wishlist

@lukegre lukegre assigned lukegre and unassigned lukegre Mar 17, 2021
@soerenthomsen
Copy link
Member

My suggestion is to make an example related to the optics / chlorophyll quenching part which seem to be well developed.

@callumrollo
Copy link
Member Author

Now that we're on conda-forge I'll move forward with some example notebooks. @lukegre what considerations should we take with these? Obviously we want to avoid recreating the monster notebook. Are the 16 MB of data in tests/data necessary?

@soerenthomsen
Copy link
Member

Great looking forward to these example notebooks! Will you focus on the optics part of GliderTools? It is very advanced! @tjryankeogh

@callumrollo
Copy link
Member Author

I have created a repo for the notebooks here:
https://github.com/callumrollo/glidertools-demo
Closing this Issue

@jbusecke
Copy link
Contributor

jbusecke commented May 5, 2021

Awesome! Should we add a link to the binder/repo to the README and/or docs?

@dhruvbalwada
Copy link
Member

I think that would be nice. If @callumrollo is interested maybe the demo repo can live in the community (https://github.com/GliderToolsCommunity) but as a separate object from the Glidertools.

@jbusecke
Copy link
Contributor

jbusecke commented May 5, 2021

Thats a great idea!

@callumrollo
Copy link
Member Author

Good shout Dhruv, I've just transferred it

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

5 participants