User's Guide - beginner's experience update

fusion-flap / flap

Fusion Library of Analysis Programs

MIT License

11 stars 5 forks source link

User's Guide - beginner's experience update #81

Closed martonvavrik closed 4 years ago

martonvavrik commented 4 years ago

Update the users guide to reflect solutions for easy set-up - from a beginner's perspective Problematic issues:

Importance of flap.Coordinate.dimension_list
Useful checking attributes (eg. flap_object.coordinate('cname') )
Importance of flap.DataObject.data_shape
Importance of flap.Coordinate.shape (eg. Slicing)
Expand the description for flap.DataObject

martonvavrik commented 4 years ago

Attached proposal for the issue. Additions in green, deletions in red. Table of contents updated. FLAP_V1.11_Users_Guide_v1.69_issue#81.docx

gergopokol commented 4 years ago

Word docs should be changed first with the "Follow changes" switched on. Should afterwards discuss if all necessary clarifications are included.

sandorzoletnik commented 4 years ago

These changes have been implemented (mostly) and version 1.70 contains them. One note: the exp_ID element is not necessarily string, the type is dependent on the data source.