Code Monkey home page Code Monkey logo

Comments (8)

giovaniceotto avatar giovaniceotto commented on May 13, 2024

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

from rocketpy.

giovaniceotto avatar giovaniceotto commented on May 13, 2024

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

from rocketpy.

giovaniceotto avatar giovaniceotto commented on May 13, 2024

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

from rocketpy.

giovaniceotto avatar giovaniceotto commented on May 13, 2024

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

from rocketpy.

giovaniceotto avatar giovaniceotto commented on May 13, 2024

List of attributes also added to Environment class.

from rocketpy.

giovaniceotto avatar giovaniceotto commented on May 13, 2024

List of attributes also added to Rocket class.

from rocketpy.

giovaniceotto avatar giovaniceotto commented on May 13, 2024

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

from rocketpy.

giovaniceotto avatar giovaniceotto commented on May 13, 2024

List of attributes also added to Flight class.

from rocketpy.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.