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

types of tutorials #113

Open
nielsenmb opened this issue Jul 18, 2019 · 2 comments
Open

types of tutorials #113

nielsenmb opened this issue Jul 18, 2019 · 2 comments
Labels
enhancement New feature or request question Further information is requested
Milestone

Comments

@nielsenmb
Copy link
Collaborator

I was thinking of the ways we can present the various examples of what PBjam can do and how to interact with it.

To start with it's probably enough to have
example-session
example-star
example-advanced

But would it maybe be an idea in the future to restructure it so that in the docs we have

  • Quick Start (basically example-session)
  • Advanced (basically example-advanced)
  • More Examples
    • How to use star class (basically example-star)
    • How to use a csv file
    • How to use custom timeseries
    • How to use custom power spectra
    • How to peakbag with GP widths

These would be short notebooks, stored safely in the docs directory where nobody will accidentally run them and/or clear all the outputs. And then we can have Guys Examples playground folder in the root directory that's just a free for all.

This should make it easier in future, when we start adding new features. Then we just write a short tutorial on how to use those new features.

@nielsenmb nielsenmb added enhancement New feature or request question Further information is requested labels Jul 18, 2019
@grd349
Copy link
Owner

grd349 commented Jul 18, 2019

Yes - this is a great idea! I want a playground! :)

@grd349 grd349 added this to the Version 2.0 milestone Jul 22, 2019
@grd349
Copy link
Owner

grd349 commented Nov 11, 2019

We do need to look at this. I can make one with a custom time series. I'll add it to my todo list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants