User Feedback

[kmruehl]

This PR contains revisions and comments based on my user feedback.

Revisions

• resolved doc compile issues, e.g. with ' and x
• updated getting_started to include: requirements and installation
• removed media directory with redundant logo file
• cleaned up doc formatting
• created a new class for IEC design load cases (IECDef)
• added dependencies to source, NOTICE and docs

Feedback

• doc updates
  • [ ] refer to inline comments with ..Kelley: syntax
  • [x] CONTRIBUTING.md should be added to the documentation, and remove redundancy/conflicting info
  • [x] README.md includes info (like installation) that's also in documentation, remove redundancy/conflicting info
• user feeback
  • [ ] Installation would be cleaner if it added the path of the local GitHub clone, e.g. C:\Users\user\Documents\GitHub\NuMAD\source
  • [ ] add a section on running example(s), like a demo
  • [ ] clean up examples, lots of files in examples, unclear which file to execute, e.g. NRT_537kg_44rpm
  • [ ] runIEC_ipt function doesn't exist in source, but called from runIEC. It must be in case directory, update doc to reflect this.
  • [ ] BAR0_UAG warnings/errors when running, Error! material ply thickness medium_density_foam not defined, assuming 1 mm thickness, looks like it's actually a warning and should be labeled as such, errors mean a run fails
  • [x] optimizationExample missing rccdata.mat, defLoadsTable.mat and failLoadsTable.mat files

[kmruehl]

@ecamare please add these files:

• [x] rccdata.mat
• [x] defLoadsTable.mat
• [x] failLoadsTable.mat

[kmruehl]

I've set up the API docs for the following classes: BladeDef, MaterialDef, StaionDef, ComponentDef AirfoilDef, StackDef. This means we can remove the legacy tables and excel sheets.

However, there are a few (minor) issues that need to be resolved for the API docs to be complete:

• [x] set.naturaloffset syntax isn't compatible with API, e.g. setNaturaloffset would be. We need to rename these for API docs to work.
• [x] several functions are not included within the BladeDef class, they are appended at the end, e.g. findLayerExtents. We need to move these functions into the class for API docs to work.

And a few more things to do:

• [x] add PolarDef
• [x] add IECDef

[kmruehl]

I've wrapped up the remaining tasks for the API documentation, but noticed there are two instances of the same fprintf_matrix function, one in BladeDef, and other in write_plot3d