Small improvements
This commit is contained in:
parent
816df855e2
commit
1dc85e17c8
@ -44,6 +44,8 @@ and for contributors to update it. It also supports versioning, so you can view
|
||||
OpenRocket, and it has a search feature that allows you to quickly find what you are looking for. Additionally, you can also
|
||||
add translations to the documentation, which makes it accessible to a wider audience.
|
||||
|
||||
----
|
||||
|
||||
Editing and Building the Documentation
|
||||
======================================
|
||||
|
||||
@ -85,12 +87,16 @@ on how to submit a pull request. If you don't want to go through the hassle of s
|
||||
`submit an issue <https://github.com/openrocket/openrocket/issues/new/choose>`__ with your proposed changes and we will take care of the rest,
|
||||
or you can `contact us <https://openrocket.info/contact.html>`__.
|
||||
|
||||
----
|
||||
|
||||
Style Guide
|
||||
===========
|
||||
|
||||
This section provides a style guide for writing documentation for OpenRocket. It covers conventions that we use in the docs
|
||||
and useful tips for writing reStructuredText/Sphinx docs.
|
||||
|
||||
.. _heading_levels:
|
||||
|
||||
Heading levels
|
||||
--------------
|
||||
|
||||
@ -131,6 +137,28 @@ For example:
|
||||
H5: This is a paragraph
|
||||
"""""""""""""""""""""""
|
||||
|
||||
Horizontal Rules
|
||||
----------------
|
||||
|
||||
Horizontal rules are used to separate sections of the documentation. They are created using four or more hyphens (----).
|
||||
|
||||
For example:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
This is a section
|
||||
=================
|
||||
|
||||
----
|
||||
|
||||
This is another section
|
||||
=======================
|
||||
|
||||
.. note::
|
||||
|
||||
As seen in the example, it is recommended to **always add a horizontal rule before starting a new section**
|
||||
(H2, see :ref:`Heading levels <heading_levels>`).
|
||||
|
||||
Adding Images
|
||||
-------------
|
||||
|
||||
|
@ -157,6 +157,8 @@ margin for error.
|
||||
:figclass: or-image-border
|
||||
:alt: A Plot of Sim #3 of the "High Power Airstart" example rocket.
|
||||
|
||||
----
|
||||
|
||||
Launch Conditions and Simulation Options
|
||||
========================================
|
||||
|
||||
@ -196,6 +198,8 @@ guide's purpose (*and frankly, beyond this author's knowledge!*).
|
||||
:figclass: or-image-border
|
||||
:alt: The Edit simulation window: Simulation options.
|
||||
|
||||
----
|
||||
|
||||
Exporting Data
|
||||
==============
|
||||
|
||||
|
@ -272,6 +272,8 @@ material flying around inside the airframe, and no need for wadding or a Nomex b
|
||||
The CO\ :sub:`2`\ ejection system is claimed to operate more reliably than black powder at extreme altitude
|
||||
(above 20,000 feet ASL), due to black powder's incomplete or non-existent burn at these altitudes.
|
||||
|
||||
----
|
||||
|
||||
Tube Fins and Ring Tails
|
||||
========================
|
||||
|
||||
@ -362,6 +364,8 @@ Your ring tail is complete.
|
||||
In addition to not being able to accurately simulate this model, it's important to note that *the body tube ring tail
|
||||
**will give you** a "Discontinuity in rocket body diameter" warning too*.
|
||||
|
||||
----
|
||||
|
||||
Through-the-Wall Fin Mounting
|
||||
=============================
|
||||
|
||||
@ -403,11 +407,15 @@ Converting a simple rocket to through-the-wall design:
|
||||
|
||||
And, a through-the-wall fin tab is automatically created between the two motor mount centering rings.
|
||||
|
||||
----
|
||||
|
||||
Electronic and Dual Deployment
|
||||
==============================
|
||||
|
||||
<<INSERTION POINT>>
|
||||
|
||||
----
|
||||
|
||||
Clustering and Multi-staging
|
||||
============================
|
||||
|
||||
@ -506,6 +514,8 @@ Rocketry is subject to regulation by federal, state, and local governments, and
|
||||
|
||||
Within the high power rocket classification, a subclassification for "complex" rockets is defined as a high power rocket that is multi-staged or propelled by a cluster of two or more rocket motors. (NFPA §1127, subd. 3.3.13.1.1.) And, a high power rocket launched with an installed total impulse greater than 2,560 N-sec (576 lb-sec) must have an electronically actuated recovery system. (NFPA §1127, subd. 4.10.2.)
|
||||
|
||||
----
|
||||
|
||||
National Association of Rocketry
|
||||
================================
|
||||
|
||||
@ -529,6 +539,8 @@ The major work of the NAR includes, but not limited to:
|
||||
|
||||
The NAR publishes the bimonthly color magazine Sport Rocketry (sent to each member and selected libraries and newsstands around the nation). The NAR provides a wide range of other services to its members, including: education programs; national and local competitions; grants to teachers and scholarships for student members; flight performance record recognition; liability insurance; and publication of technical literature.
|
||||
|
||||
----
|
||||
|
||||
Tripoli Rocketry Association
|
||||
=============================
|
||||
|
||||
|
@ -29,6 +29,8 @@ direction into account, and a *lot* more.
|
||||
|
||||
If you already know how to run basic simulations, you can jump to the :doc:`Advanced Rocket Design </user_guide/advanced_rocket_design>`.
|
||||
|
||||
----
|
||||
|
||||
Running a simple simulation
|
||||
===========================
|
||||
|
||||
@ -101,6 +103,8 @@ These are common failure conditions, but are not intended to be an exhaustive li
|
||||
|
||||
.. _motors-configuration:
|
||||
|
||||
----
|
||||
|
||||
Motors & Configuration
|
||||
======================
|
||||
|
||||
@ -215,6 +219,8 @@ parameters, and its certification.
|
||||
|
||||
The **Show Details** section.
|
||||
|
||||
----
|
||||
|
||||
Getting a Good Simulation
|
||||
=========================
|
||||
|
||||
|
@ -178,6 +178,8 @@ your own rocket.
|
||||
Let’s have a look at the full list of components. If you cannot click on the component type, try selecting the
|
||||
*Body tube* in the design window in the top left panel of OpenRocket.
|
||||
|
||||
----
|
||||
|
||||
Available Design Elements
|
||||
=========================
|
||||
|
||||
@ -290,6 +292,8 @@ Within *Mass Components* we have 4 component types. They are:
|
||||
|
||||
You have now had a brief run through the various components available for use in OpenRocket. The next section will deal with an example rocket.
|
||||
|
||||
----
|
||||
|
||||
*A Simple Model Rocket* Example
|
||||
===============================
|
||||
|
||||
@ -414,6 +418,8 @@ We have now looked through the components used within the simple model rocket ex
|
||||
available components, see **Appendix A**. Now that we are familiar with what makes up the rocket we will go ahead and
|
||||
build one from scratch!
|
||||
|
||||
----
|
||||
|
||||
Building *A simple model rocket*
|
||||
================================
|
||||
|
||||
|
@ -30,6 +30,8 @@ window showing all your custom expressions.
|
||||
Initially, there will be no custom expressions, so you will need to add one using the *New expression* button in the
|
||||
lower right. This opens the expression builder window. You can also import expressions from another .ork file.
|
||||
|
||||
----
|
||||
|
||||
Building expressions
|
||||
====================
|
||||
|
||||
@ -62,6 +64,8 @@ from which you can choose a variable and insert it (at the current cursor positi
|
||||
particularly useful because you may not be able to type some of the symbols on your keyboard. The :guilabel:`Insert Operator`
|
||||
window is similar and shows all the available mathematical operators and functions.
|
||||
|
||||
----
|
||||
|
||||
Index expressions
|
||||
=================
|
||||
|
||||
@ -90,6 +94,8 @@ of the time steps of the simulation.
|
||||
If you specify a time smaller than 0 or greater than t then it will be clipped to 0 or t respectively. You can't access
|
||||
data that has not been calculated yet.
|
||||
|
||||
----
|
||||
|
||||
Range expressions
|
||||
=================
|
||||
|
||||
@ -131,6 +137,8 @@ This facilitates easy integration or optimization with functions such as *trapz(
|
||||
|
||||
For a complete list of all the operators available see the operator selection list when making a new expression.
|
||||
|
||||
----
|
||||
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
|
@ -149,6 +149,8 @@ being calculated over the course of the flight.
|
||||
|
||||
After applying these modifications, you will have a more accurate simulation for future flights with different motors.
|
||||
|
||||
----
|
||||
|
||||
How and Why to Use Mass and Center of Gravity Overrides
|
||||
=======================================================
|
||||
|
||||
@ -259,6 +261,8 @@ As stated before, before you head out to the range, **actually install the motor
|
||||
margin of stability***; again, it's always nice to put markers on the rocket, blue for the center of gravity and red for
|
||||
the center of pressure.
|
||||
|
||||
----
|
||||
|
||||
How and Why to Use Surface Finish Settings and Coefficient of Drag (C\ :sub:`D`) Overrides
|
||||
==========================================================================================
|
||||
|
||||
|
@ -64,6 +64,8 @@ remove it from the simulation:
|
||||
|
||||
Air-start extension pane.
|
||||
|
||||
----
|
||||
|
||||
Creating a New OpenRocket Extension
|
||||
===================================
|
||||
|
||||
@ -417,6 +419,8 @@ When the resulting configurator is displayed, it looks like this:
|
||||
|
||||
The surrounding Dialog window and the **Close** button are provided by the system.
|
||||
|
||||
----
|
||||
|
||||
Example User Extensions Provided With OpenRocket
|
||||
================================================
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user