Combine tutorial and user guide contents #244

Closed
khughitt opened this Issue Aug 14, 2012 · 10 comments

Comments

Projects
None yet
4 participants
@khughitt
Member

khughitt commented Aug 14, 2012

Currently the tutorial and user guide material are arbitrarily separated -- some of the "quick tutorial" as long or longer than sections in the main user guide. Further, some topics are covered in the tutorial but not in the user guide.

It is confusing where one should look for any particular topic.

Perhaps we could drop the "quick tutorial" and merge the contents into the main user guide? At a minimum, we should make sure all of the topics covered in the quick tutorial are covered at least as well in the user guide.

@Cadair

This comment has been minimized.

Show comment Hide comment
@Cadair

Cadair Aug 15, 2012

Member

Hello,

Everything that is in the "Quick Tutorial" should be in the main user guide. I however think that having a quick introduction that perhaps just uses built in data and shows people around while not going into too much detail is a good thing.

It looks like the VSO and Helioviewer.org data grabbing are missing from the main docs, perhaps a data downloading section would be a good idea? Also perhaps the time and constants could be wrapped up and expanded into a section in the main user guide?

just a thought or two.

Member

Cadair commented Aug 15, 2012

Hello,

Everything that is in the "Quick Tutorial" should be in the main user guide. I however think that having a quick introduction that perhaps just uses built in data and shows people around while not going into too much detail is a good thing.

It looks like the VSO and Helioviewer.org data grabbing are missing from the main docs, perhaps a data downloading section would be a good idea? Also perhaps the time and constants could be wrapped up and expanded into a section in the main user guide?

just a thought or two.

@wafels

This comment has been minimized.

Show comment Hide comment
@wafels

wafels Aug 15, 2012

Member

I think it is definitely worth having a quick introduction to sunpy. The
key word is "introduction". Simple examples of what sunpy can do is what
people will want to see.

For example:

Loading in FITS files
A map example
A lightcurve example
Playing a mapcube movie
A VSO example
A HEK example

One or two lines of python per example should be enough.

jack

On Wed, Aug 15, 2012 at 5:07 AM, Stuart Mumford notifications@github.comwrote:

Hello,

Everything that is in the "Quick Tutorial" should be in the main user
guide. I however think that having a quick introduction that perhaps just
uses built in data and shows people around while not going into too much
detail is a good thing.

It looks like the VSO and Helioviewer.org data grabbing are missing from
the main docs, perhaps a data downloading section would be a good idea?
Also perhaps the time and constants could be wrapped up and expanded into a
section in the main user guide?

just a thought or two.


Reply to this email directly or view it on GitHubhttps://github.com/sunpy/sunpy/issues/244#issuecomment-7751543.

Member

wafels commented Aug 15, 2012

I think it is definitely worth having a quick introduction to sunpy. The
key word is "introduction". Simple examples of what sunpy can do is what
people will want to see.

For example:

Loading in FITS files
A map example
A lightcurve example
Playing a mapcube movie
A VSO example
A HEK example

One or two lines of python per example should be enough.

jack

On Wed, Aug 15, 2012 at 5:07 AM, Stuart Mumford notifications@github.comwrote:

Hello,

Everything that is in the "Quick Tutorial" should be in the main user
guide. I however think that having a quick introduction that perhaps just
uses built in data and shows people around while not going into too much
detail is a good thing.

It looks like the VSO and Helioviewer.org data grabbing are missing from
the main docs, perhaps a data downloading section would be a good idea?
Also perhaps the time and constants could be wrapped up and expanded into a
section in the main user guide?

just a thought or two.


Reply to this email directly or view it on GitHubhttps://github.com/sunpy/sunpy/issues/244#issuecomment-7751543.

@khughitt

This comment has been minimized.

Show comment Hide comment
@khughitt

khughitt Aug 15, 2012

Member

Sounds good. Anyone want to volunteer to tackle this reorganization? :)

Here are some changes I would propose to make:

[Tutorial]

  • Change "A quick tutorial" to something like "SunPy in five minutes" or "A brief tour of SunPy"? (subjective...)
  • Add an example of calling show() with customizing norm/cmap.
  • Move colormap example to color maps section of user guide
  • Movie Helioviewer section to user guide
  • Comment out/remove plotman section (will update once Matt's new GUI is ready for use)
Member

khughitt commented Aug 15, 2012

Sounds good. Anyone want to volunteer to tackle this reorganization? :)

Here are some changes I would propose to make:

[Tutorial]

  • Change "A quick tutorial" to something like "SunPy in five minutes" or "A brief tour of SunPy"? (subjective...)
  • Add an example of calling show() with customizing norm/cmap.
  • Move colormap example to color maps section of user guide
  • Movie Helioviewer section to user guide
  • Comment out/remove plotman section (will update once Matt's new GUI is ready for use)
@khughitt

This comment has been minimized.

Show comment Hide comment
@khughitt

khughitt Aug 15, 2012

Member

Also- perhaps we could organize the content that already exists in the user guide a little better, e.g.:

  1. Installation
  2. A Brief Tour of SunPy
  3. Basic SunPy Data types
    • Maps
    • LightCurves
    • Spectra
  4. Advanced SunPy Data types
    • CompositeMap
    • MapCube
    • etc.
  5. Constants
  6. Dates and Times
  7. Coordinate Systems
  8. Net tools (?)
  9. Misc. Utils
    etc?
Member

khughitt commented Aug 15, 2012

Also- perhaps we could organize the content that already exists in the user guide a little better, e.g.:

  1. Installation
  2. A Brief Tour of SunPy
  3. Basic SunPy Data types
    • Maps
    • LightCurves
    • Spectra
  4. Advanced SunPy Data types
    • CompositeMap
    • MapCube
    • etc.
  5. Constants
  6. Dates and Times
  7. Coordinate Systems
  8. Net tools (?)
  9. Misc. Utils
    etc?

@ghost ghost assigned wafels Aug 15, 2012

@Cadair

This comment has been minimized.

Show comment Hide comment
@Cadair

Cadair Sep 15, 2012

Member

Would you like me to take a crack at this? Or are you working on it Jack?

Member

Cadair commented Sep 15, 2012

Would you like me to take a crack at this? Or are you working on it Jack?

@khughitt

This comment has been minimized.

Show comment Hide comment
@khughitt

khughitt Sep 15, 2012

Member

Go for it :)

On Sat, Sep 15, 2012 at 9:47 AM, Stuart Mumford notifications@github.comwrote:

Would you like me to take a crack at this? Or are you working on it Jack?


Reply to this email directly or view it on GitHubhttps://github.com/sunpy/sunpy/issues/244#issuecomment-8584852.

Member

khughitt commented Sep 15, 2012

Go for it :)

On Sat, Sep 15, 2012 at 9:47 AM, Stuart Mumford notifications@github.comwrote:

Would you like me to take a crack at this? Or are you working on it Jack?


Reply to this email directly or view it on GitHubhttps://github.com/sunpy/sunpy/issues/244#issuecomment-8584852.

@ghost ghost assigned Cadair and wafels Sep 16, 2012

@Cadair

This comment has been minimized.

Show comment Hide comment
@Cadair

Cadair Oct 12, 2012

Member

I shall do this when Steven's and my PRs are merged.

Member

Cadair commented Oct 12, 2012

I shall do this when Steven's and my PRs are merged.

@Cadair

This comment has been minimized.

Show comment Hide comment
@Cadair

Cadair Nov 12, 2012

Member

Do people have anything else that should be added to the documentation to close this issue?

Member

Cadair commented Nov 12, 2012

Do people have anything else that should be added to the documentation to close this issue?

@ehsteve

This comment has been minimized.

Show comment Hide comment
@ehsteve

ehsteve Nov 15, 2012

Member

Just looked over the refactoring, it looks good though I've found errors in various errors so I am going to add a 0.2 bug to go over each line of quoted code in the docs strings and guide to make it everything works.

Member

ehsteve commented Nov 15, 2012

Just looked over the refactoring, it looks good though I've found errors in various errors so I am going to add a 0.2 bug to go over each line of quoted code in the docs strings and guide to make it everything works.

@ehsteve ehsteve closed this Nov 15, 2012

@khughitt

This comment has been minimized.

Show comment Hide comment
@khughitt

khughitt Nov 15, 2012

Member

@Cadair @ehsteve Thanks for all of your work on this guys!

Member

khughitt commented Nov 15, 2012

@Cadair @ehsteve Thanks for all of your work on this guys!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment