Feature #2282

Enhancement of documentation for 1.5 release

Added by Tibaldo Luigi over 6 years ago. Updated over 6 years ago.

Status:ClosedStart date:11/28/2017
Priority:NormalDue date:
Assigned To:Tibaldo Luigi% Done:

100%

Category:-
Target version:1.5.0
Duration:

Description

Various tasks enhance the user documentation toward the release of 1.5


Recurrence

No recurrence.

History

#1 Updated by Tibaldo Luigi over 6 years ago

  • Checklist changed from [ ] Reorder User Documentation to [x] Reorder User Documentation

#2 Updated by Tibaldo Luigi over 6 years ago

  • Checklist changed from [ ] Add more information on par files to [x] Add more information on par files

#3 Updated by Tibaldo Luigi over 6 years ago

  • Checklist changed from [ ] Add to Tutorial/First steps info on classical analysis to [x] Add to Tutorial/First steps info on classical analysis

#4 Updated by Tibaldo Luigi over 6 years ago

To integrate the On/Off part in the quickstart tutorial all the material was revised to use off-axis observations.

#5 Updated by Tibaldo Luigi over 6 years ago

  • Checklist changed from [x] Reorder User Documentation, [x] Add more information on par files, [x] Add to Tutorial/First steps info on classical analysis, [ ] Turn tutorial on stacked analysis into notebook, [ ] Add notebook on iterative model improvement to [x] Reorder User Documentation, [x] Add more information on par files, [x] Add to Tutorial/First steps info on classical analysis, [x] Turn tutorial on stacked analysis into notebook, [ ] Add notebook on iterative model improvement
  • % Done changed from 60 to 80

Also the tutorial on combined likelihood analysis was turned into ipynb so that the necessary dataset is produced.

#6 Updated by Tibaldo Luigi over 6 years ago

  • Status changed from New to In Progress

#7 Updated by Tibaldo Luigi over 6 years ago

  • Checklist changed from [ ] Add notebook on iterative model improvement to [x] Add notebook on iterative model improvement

#8 Updated by Tibaldo Luigi over 6 years ago

  • Status changed from In Progress to Pull request

Some notes:
- I modified the dataset simulation for the quickstart section in order to have an off-axis observation and therefore be able to use a single dataset also for the On/Off section.
- I reshuffled some material from the On/Off 1DC tutorial into the newly added On/Off quickstart tutorial to limit duplication.
- I discovered a mistake in the y-axis label for the show_butterfly and show_spectrum example scripts that I fixed along with the documentation work.

#9 Updated by Knödlseder Jürgen over 6 years ago

  • Status changed from Pull request to Closed
  • Target version set to 1.5.0

Merged code into devel.

Also available in: Atom PDF