Finish documenting code in rocketpyAlpha.py

[giovaniceotto]

The code in nbks/rocketpyAlpha.py is not fully documented. Methods in classes Motor, Rocket and Flight are missing docstring documentation.

[giovaniceotto]

Methods with missing documentation are:

• Motor

  • refresh
  • reshapeThrustCurve
  • info - Should be simplied and allInfo should be created
  • evaluateTotalImpulse
  • evaluateExhaustVelocity
  • evaluateMassDot
  • evaluateMass
  • evaluateGeometry
  • evaluateInertia
  • __burnRate
  • importEng
  • exportEng

• Rocket

  • info - Should be simplified and allInfo should be created
  • refresh
  • evaluateReducedMass
  • evaluateTotalMass
  • serMotor
  • refreshStaticMargin
  • addCMExcentricity
  • addCPExcentricity
  • addMotorExcentricity

• Flight

  • postProcess
  • info
  • allInfo
  • animate - Should be removed, not working well
  • __uDotRailOpt - Opt suffix should be removed, as this is the standard implementation
  • __uDotOpt - Opt suffix should be removed, as this is the standard implementation
  • __uDotDrogue - Should be removed, replaced by uDotParachute
  • __uDotMain - Should be removed, replaced by uDotParachute
  • __uDotParachute

[giovaniceotto]

Methods documented in branch complete_documentation as of today are:

• Motor

  • refresh - Removed - Does not make sense to have in current Motor implementation, should be replaced by more efficient version later
  • reshapeThrustCurve - Documented
  • evaluateTotalImpulse - Documented
  • evaluateExhaustVelocity - Documented
  • evaluateMassDot - Documented - Also made significantly more time efficient (~100x) by replacing setDiscrete usage by more elementary methods
  • evaluateMass - Documented - Also made significantly more time efficient (~100x) by replacing integrate.odeint usage by trapezoidal rule, which gives the same result to 1e-7 accuracy
  • evaluateGeometry - Documented
  • evaluateInertia - Documented - Can be made much more efficient by replacing setDiscrete by more elementary methods or fixing issue #8
  • __burnRate - Removed - Was rewritten inside evaluateGeometry under the name geometryDot to speed up execution and eliminate the only private method
  • importEng - Documented
  • exportEng - Documented
  • info - Documented
  • allInfo - Documented

• Rocket

  • info - Should be simplified and allInfo should be created
  • refresh
  • evaluateReducedMass
  • evaluateTotalMass
  • serMotor
  • refreshStaticMargin
  • addCMExcentricity
  • addCPExcentricity
  • addMotorExcentricity

• Flight

  • postProcess
  • info
  • allInfo
  • animate - Should be removed, not working well
  • __uDotRailOpt - Opt suffix should be removed, as this is the standard implementation
  • __uDotOpt - Opt suffix should be removed, as this is the standard implementation
  • __uDotDrogue - Should be removed, replaced by uDotParachute
  • __uDotMain - Should be removed, replaced by uDotParachute
  • __uDotParachute

[giovaniceotto]

Methods documented in branch complete_documentation as of today are:

• Motor

  • refresh - Removed - Does not make sense to have in current Motor implementation, should be replaced by more efficient version later
  • reshapeThrustCurve - Documented
  • evaluateTotalImpulse - Documented
  • evaluateExhaustVelocity - Documented
  • evaluateMassDot - Documented - Also made significantly more time efficient (~100x) by replacing setDiscrete usage by more elementary methods
  • evaluateMass - Documented - Also made significantly more time efficient (~100x) by replacing integrate.odeint usage by trapezoidal rule, which gives the same result to 1e-7 accuracy
  • evaluateGeometry - Documented
  • evaluateInertia - Documented - Can be made much more efficient by replacing setDiscrete by more elementary methods or fixing issue #8
  • __burnRate - Removed - Was rewritten inside evaluateGeometry under the name geometryDot to speed up execution and eliminate the only private method
  • importEng - Documented
  • exportEng - Documented
  • info - Documented
  • allInfo - Documented

• Rocket

  • refresh - Removed - Does not make sense to have in current Rocket implementation, should be replaced by more efficient version later
  • evaluateReducedMass - Documented - Can be made 100x more efficient by replacing setDiscrete by more elementary methods or fixing issue #8
  • evaluateTotalMass - Documented - Can be made 100x more efficient by replacing setDiscrete by more elementary methods or fixing issue #8
  • evaluateStaticMargin - Documented - Replaced refreshStaticMargin
  • setMotor - Removed - Does not make sense to have in current Rocket implementation, should be replaced by more suited version later
  • addCMExcentricity - Documented
  • addCPExcentricity - Documented
  • addMotorExcentricity - Documented
  • info - Documented
  • allInfo - Documented

• Flight

  • postProcess
  • info
  • allInfo
  • animate - Should be removed, not working well
  • __uDotRailOpt - Opt suffix should be removed, as this is the standard implementation
  • __uDotOpt - Opt suffix should be removed, as this is the standard implementation
  • __uDotDrogue - Should be removed, replaced by uDotParachute
  • __uDotMain - Should be removed, replaced by uDotParachute
  • __uDotParachute

[giovaniceotto]

I have also added a list of attributes to the Motor class. Would be nice to do the same for the other classes.

[giovaniceotto]

List of attributes also added to Environment class.

[giovaniceotto]

List of attributes also added to Rocket class.

[giovaniceotto]

Methods documented in branch complete_documentation as of today are:

• Motor

  • refresh - Removed - Does not make sense to have in current Motor implementation, should be replaced by more efficient version later
  • reshapeThrustCurve - Documented
  • evaluateTotalImpulse - Documented
  • evaluateExhaustVelocity - Documented
  • evaluateMassDot - Documented - Also made significantly more time efficient (~100x) by replacing setDiscrete usage by more elementary methods
  • evaluateMass - Documented - Also made significantly more time efficient (~100x) by replacing integrate.odeint usage by trapezoidal rule, which gives the same result to 1e-7 accuracy
  • evaluateGeometry - Documented
  • evaluateInertia - Documented - Can be made much more efficient by replacing setDiscrete by more elementary methods or fixing issue #8
  • __burnRate - Removed - Was rewritten inside evaluateGeometry under the name geometryDot to speed up execution and eliminate the only private method
  • importEng - Documented
  • exportEng - Documented
  • info - Documented
  • allInfo - Documented

• Rocket

  • refresh - Removed - Does not make sense to have in current Rocket implementation, should be replaced by more efficient version later
  • evaluateReducedMass - Documented - Can be made 100x more efficient by replacing setDiscrete by more elementary methods or fixing issue #8
  • evaluateTotalMass - Documented - Can be made 100x more efficient by replacing setDiscrete by more elementary methods or fixing issue #8
  • evaluateStaticMargin - Documented - Replaced refreshStaticMargin
  • setMotor - Removed - Does not make sense to have in current Rocket implementation, should be replaced by more suited version later
  • addCMExcentricity - Documented
  • addCPExcentricity - Documented
  • addMotorExcentricity - Documented
  • info - Documented
  • allInfo - Documented

• Flight

  • postProcess - Documented
  • __uDotRail - Documented - Opt suffix removed
  • __uDot - Documented - Opt suffix removed
  • __uDotParachute - Documented
  • info - Documented
  • allInfo - Documented
  • animate - Quarantined as not implemented
  • __uDotDrogue - Removed - Replaced by uDotParachute
  • __uDotMain - Removed - Replaced by uDotParachute

[giovaniceotto]

List of attributes also added to Flight class.