hongshaorou/openrocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1 from JoePfeiffer/sphinx-docs

Browse Source 
Update codebase walkthrough for OpenRocket core
This commit is contained in:
Sibo Van Gool 2024-06-05 01:54:06 +02:00 committed by GitHub
commit b76c9a2d04
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 73 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/resources-src/datafiles/openrocket-database

@ -1 +1 @@
Subproject commit 48eb2172d58c0db6042bd847a782835df056b287 Subproject commit 93054dc2b40d5196433b1d91c636cee2e9dda424

145
docs/source/dev_guide/codebase_walkthrough.rst
View File

@ -44,82 +44,81 @@ The following is an overview of the packages in the ``info.openrocket.core`` mod
.. code-block:: none .. code-block:: none
├── aerodynamics # Calculation of aerodynamic properties (e.g. drag) ├── aerodynamics # Calculation of aerodynamic properties (e.g. aerodynamic forces, CD)
│ └── barrowman # Barrowman method for calculating coefficient of drag (CD) │ └── barrowman # Barrowman method for calculating aerodynamic properties
├── appearance # Appearance of components (e.g. color, texture) ├── appearance # Appearance of components (e.g. color, texture)
│ └── defaults # Default appearance settings │ └── defaults # Default appearance settings
├── arch # Get info on the system architecture (macOS, Windows, Linux) ├── arch # Get info on the system architecture (macOS, Windows, Linux)
├── communication # Communication with external sites/programs (e.g. retrieve the latest version of OpenRocket from GitHub) ├── communication # Communication with external sites/programs (e.g. retrieve the latest version of OpenRocket from GitHub)
├── database # Database handling (component database, motor database) ├── database # Database handling (component database, motor database)
│ └── motor # Thrust curve database │ └── motor # Thrust curve (i.e. motor) database
├── document # OpenRocket document and simulation handling ├── document # OpenRocket document and simulation handling
│ ├── attachments # Attachments to OpenRocket documents │ ├── attachments # Attachments to OpenRocket documents
│ └── events # OpenRocket events (e.g. document changed, simulation changed) │ └── events # OpenRocket events (i.e. document changed, simulation changed)
├── file # File handling ├── file # File handling
│ ├── configuration │ ├── iterator # Iterate files in e.g. a directory or a zip file
│ ├── iterator # Iterate files in e.g. a directory or a zip file │ ├── motor # Motor files handling
│ ├── motor # Motor files handling │ ├── openrocket # OpenRocket file handling
│ ├── openrocket # OpenRocket file handling │ │ ├── importt # Import OpenRocket files
│ │ ├── importt # Import OpenRocket files │ │ └── savers # Save OpenRocket files
│ │ └── savers # Save OpenRocket files │ ├── rasaero # RASAero II file handling
│ ├── rasaero # RASAero II file handling │ │ ├── export # Export OpenRocket files to RASAero II
│ │ ├── export # Export OpenRocket files to RASAero II │ │ └── importt # Import RASAero II files to OpenRocket
│ │ └── importt # Import RASAero II files to OpenRocket │ ├── rocksim # RockSim file handling
│ ├── rocksim # RockSim file handling │ │ ├── export # Export OpenRocket files to RockSim
│ │ ├── export # Export OpenRocket files to RockSim │ │ └── importt # Import RockSim files to OpenRocket
│ │ └── importt # Import RockSim files to OpenRocket │ ├── simplesax # XML file handling
│ ├── simplesax # XML file handling │ ├── svg # SVG file handling
│ ├── svg # SVG file handling │ │ └── export # SVG export
│ │ └── export # SVG export │ └── wavefrontobj # Wavefront OBJ file handling
│ └── wavefrontobj # Wavefront OBJ file handling │ └── export # Export OpenRocket components to Wavefront OBJ
│ └── export # Export OpenRocket components to Wavefront OBJ
│ ├── components # Export OpenRocket components │ ├── components # Export OpenRocket components
│ └── shapes # Export general geometry shapes │ └── shapes # Export general geometry shapes
├── formatting # Formatting of e.g. motor config names ├── formatting # Formatting of e.g. motor config names
├── gui ├── gui
│ └── util │ └── util # Filename filter
├── l10n # Translation of OpenRocket ├── l10n # Localization (translation of OpenRocket into languages other than English)
├── logging # Logging and message handling (e.g. error and warning messages) ├── logging # Errors, warnings, and aborts
├── masscalc # Calculation of mass properties (weight and center of gravity) ├── masscalc # Mass property (e.g. mass, CG, moments of inertia) calculation drivers. Actual component mass calculations are in the components themselves
├── material # Material properties (physical properties of materials) ├── material # Material properties (physical properties of materials)
├── models # Physical models (e.g. atmosphere, gravity, wind) ├── models # Physical models (e.g. atmosphere, gravity, wind)
│ ├── atmosphere # Atmosphere models │ ├── atmosphere # Atmosphere models
│ ├── gravity # Gravity models │ ├── gravity # Gravity models
│ └── wind # Wind models │ └── wind # Wind models
├── motor ├── motor # Motor configuration, ID, and thrustcurves
├── optimization # Optimization algorithms ├── optimization # Optimization algorithms
│ ├── general │ ├── general # Parameter search space algorithms
│ │ ├── multidim │ │ ├── multidim # Multidimensional parallel search optimization
│ │ └── onedim │ │ └── onedim # One dimensional golden-section search optimization
│ ├── rocketoptimization │ ├── rocketoptimization # Optimization of rocket parameters for specified goal functions
│ │ ├── domains │ │ ├── domains # Limits on optimization parameters
│ │ ├── goals │ │ ├── goals # Max, min, and specific value optimization goals
│ │ ├── modifiers │ │ ├── modifiers # Modify rocket parameters
│ │ └── parameters │ │ └── parameters # Simulation results that can be optimized
│ └── services │ └── services # Provide parameters etc to optimizer
├── plugin ├── plugin # Plugin interface (more general but less developed than extension interface)
├── preset ├── preset # Component presets
│ ├── loader │ ├── loader # Component database file loader
│ └── xml │ └── xml # Component database file writer
├── rocketcomponent # Rocket components (e.g. fins, nose cone, tube) ├── rocketcomponent # Rocket components (e.g. fins, nose cone, tube)
│ └── position # Position of rocket components │ └── position # Position of rocket components
├── rocketvisitors ├── rocketvisitors # Create lists of components and motors
├── scripting ├── scripting # Javascript scripting of OR functionality
├── simulation ├── simulation # Flight simulation code
│ ├── customexpression │ ├── customexpression # User defined custom expression handling
│ ├── exception │ ├── exception # Exceptions occurring during simulation
│ ├── extension │ ├── extension # User defined simulation extensions
│ │ ├── example │ │ ├── example # Examples of simulation extensions
│ │ └── impl │ │ └── impl # Helper methods for implementing extensions
│ └── listeners │ └── listeners # Code "listening" to simulation to implement functionality
│ ├── example │ ├── example # Example user listeners
│ └── system │ └── system # Listeners used by OpenRocket itself
├── startup ├── startup # Root Application and related classes
├── thrustcurve ├── thrustcurve # Thrustcurve file and thrustcurve.org API
├── unit ├── unit # Definitions of units and unit conversions
├── util ├── util # Miscellaneous utility methods
│ └── enums │ └── enums # Conversion of enums to names
└── utils └── utils # More utility methods
Swing Module Swing Module