Difference between revisions of "Getting Started"

From OpenRocket wiki
Jump to navigation Jump to search
m (79 revisions: Import existing wiki English pages)
 
(Changes made to grammar, punctuation and I've also standardized the use of "OpenRocket" instead of the mix of this and Openrocket," as per the official website. I also fixed the formatting in a few areas.)
Line 10: Line 10:
 
__TOC__
 
__TOC__
  
In this section we have a look at how Openrocket is organized, by analysing in detail the structure of the <b>user interface</b>. <br />
+
In this section we have a look at how OpenRocket is organized, by analyzing in detail the structure of the <b>user interface</b>. We will also briefly mention the <b>Example projects</b> that are accessible from the <i>File</i> menu. After reading this section you will have a thorough understanding of how OpenRocket is structured, and will be ready to start designing a rocket of your own. If you already know how this program is organized, feel free to jump to the [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Basic_Rocket_Design next section].
We will also briefly mention the <b>Example projects</b> that are accesible from the <i>File</i> menu.  
 
After reading this section you will have a thorough understanding of how Openrocket is structured and will be ready to start designing a rocket of your own. <br />
 
If you already know well how this program is organized, feel free to jump to the [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Basic_Rocket_Design next section].
 
  
  
 
= The User interface =
 
= The User interface =
  
In this subsection we first briefly discuss the <b><i>Rocket Configuration</i></b> window, and then Openrocket's <b><i>main window</i></b> and the <i>main window</i>'s four <b>menus</b>. <br />
+
In this subsection we first briefly discuss the <b><i>Rocket Configuration</i></b> window, and then OpenRocket's <b><i>main window</i></b> and the <i>main window</i>'s four <b>menus</b>. <br />
  
  
Line 27: Line 24:
 
[[File:Rocket_configuration.png|thumb|600 px|center|The <i>Rocket Configuration</i> window.]]
 
[[File:Rocket_configuration.png|thumb|600 px|center|The <i>Rocket Configuration</i> window.]]
  
Fill in the four fields (or you can leave all, except the <i>Design name</i>, blank if you wish) and click the <i>close</i> button. <br />
+
Fill in the four fields (or you can leave all, except the <i>Design name</i>, blank if you wish), and click the <i>close</i> button. <br />
  
  
== Openrocket's <i>main window</i> ==
+
== OpenRocket's <i>main window</i> ==
  
You now have access to the <b>Openrocket <i>main window</i></b>.
+
You now have access to the <b>OpenRocket <i>main window</i></b>.
  
[[File:Main_window.png|thumb|800 px|center|The Openrocket <i>main window</i>.]]
+
[[File:Main_window.png|thumb|800 px|center|The OpenRocket <i>main window</i>.]]
  
Notice there are two tabs in the top-left corner of the window, which allow you to switch between <i>Rocket design</i> and <i>Flight simulations</i>. <br />
+
Notice there are two tabs in the top-left corner of the window, just under the menu options. These tabs allow you to switch between the <i>Rocket design</i> and <i>Flight simulations</i> windows. <br />
  
  
Line 43: Line 40:
 
For the moment, let's focus on the <i>Rocket design</i> window. This window is organized in the following way: <br />
 
For the moment, let's focus on the <i>Rocket design</i> window. This window is organized in the following way: <br />
 
- in the bottom half of the window there is a large white space. This is where a 2D image of the rocket you are designing will appear. <br />  
 
- in the bottom half of the window there is a large white space. This is where a 2D image of the rocket you are designing will appear. <br />  
- in the top-left part of the window, the rocket's <b>stages</b> and <b>components</b> are shown. When you start a new project, the rocket contains only one stage, i.e. the <b>sustainer</b> and no components. <br />
+
- in the top-left part of the window, the rocket's <b>stages</b> and <b>components</b> are shown. When you start a new project, the rocket contains only one stage (i.e.; the <b>sustainer</b>) but no components. <br />
- in the top-right part of the window, all the <b>body components</b> and <b>fin sets</b>, <b>inner components</b>, and <b>mass objects</b> that you can add to the rocket are shown. Notice that it's not possible to add all of these object to the rocket at any particular stage of the rocket design. Exactly which components can be added when will be explained later on. <br />
+
- in the top-right part of the window, all the <b>body components</b> and <b>fin sets</b>, <b>inner components</b>, and <b>mass objects</b> that you can add to the rocket are shown. Notice that it's not possible to add all of these object to the rocket at any particular stage of the rocket design. Exactly which components can be added when will be explained later in this guide. <br /><br />
Now let's have a more close look at the bottom half of the <i>Rocket design</i> window. When you add a component to your rocket, it will be immediately displayed, as shown below:
+
 
 +
Now let's have a closer look at the bottom half of the <i>Rocket design</i> window. When you add a component to your rocket, it will be immediately displayed, as shown below:
  
 
[[File:After_first_component.png|thumb|1000 px|center|Bottom half of the <i>Rocket design</i> window after adding a <b>nose cone</b>.]]
 
[[File:After_first_component.png|thumb|1000 px|center|Bottom half of the <i>Rocket design</i> window after adding a <b>nose cone</b>.]]
  
Notice the <b>rulers</b> around the borders, which give you an idea of the dimensions of your rocket. <br />
+
Notice the <b>rulers</b> around the borders. These give you an idea of the dimensions of your rocket. <br /><br />
As you can see, not only the appearance of you rocket is shown in this part of the <i>Rocket design</i> window, but also some useful information, such as the rocket's <b>dimensions</b>, <b>mass</b>, <b>apogee</b>, <b>max. velocity</b>, <b>max. acceleration</b>, <b>stability</b>, <b>center of gravity</b> (<b>CG</b>), and <b>center of pressure</b> (<b>CP</b>), is shown. <br />
+
 
In the top left-hand corner of the previous image there are two buttons, i.e. <i>Side view</i> and <i>Back view</i>, which allow you to visualise the rocket from two different positions. Next to these you can find the <i>zoom-regulation commands</i> and then one <i>Stage i</i> button for each <b>Stage</b> in your rocket. Selecting/deselecting each of these allows you to incluse/exlclude each stage from the picture. <br />
+
As you can see, in addition to the appearance of your rocket, the <i>Rocket design</i> window also shows some other useful information as well. This includes the rocket's <b>dimensions</b>, <b>mass</b>, <b>apogee</b>, <b>max. velocity</b>, <b>max. acceleration</b>, <b>stability</b>, <b>center of gravity</b> (<b>CG</b>), and <b>center of pressure</b> (<b>CP</b>). <br /><br />
On the left of the previous image you can also see a scroll bar which allows you ro rotate the rocket up to 360°. <br />
+
 
Finally, notice the drop-down list in the top right-hand corner of the previous image. This allows you to choose which of your <b>motor configurations</b> to apply to the rocket you have designed (more on this later).
+
In the top left-hand corner of the previous image there are two buttons: <i>Side view</i> and <i>Back view</i>. These allow you to visualize the rocket from two different positions. Next to these buttons you can find the <i>zoom-regulation commands</i> and then one <i>Stage i</i> button for each <b>Stage</b> in your rocket. Selecting/deselecting each of these allows you to include or exclude each stage from the picture. On the left of the previous image you can also see a scroll bar that allows you to rotate the rocket up to 360°. <br /><br />
The image below shows how the bottom half of the <i>Rocket design</i> window appears after the rocket design has been completed.
+
 
 +
Finally, notice the drop-down list in the top right-hand corner of the previous image. This allows you to choose which of your <b>motor configurations</b> to apply to the rocket you have designed (more on this later). The image below shows how the bottom half of the <i>Rocket design</i> window appears after the rocket design has been completed.
  
 
[[File:After_complete_design.png|thumb|1000 px|center|Bottom half of the <i>Rocket design</i> window after completing the rocket's design (taken from the <i>A simple model rocket</i> example design).]]
 
[[File:After_complete_design.png|thumb|1000 px|center|Bottom half of the <i>Rocket design</i> window after completing the rocket's design (taken from the <i>A simple model rocket</i> example design).]]
  
In this image, the rocket's <b>body components</b> and <b>fin sets</b> are represented with a continous blue line, the rocket's <b>inner components</b> are represented with a continous red line (the <b>inner tube</b> is also filled in with a grey background), and the <b>mass objects</b> are represented with either black or red dotted lines. <br />
+
In this image, the rocket's <b>body components</b> and <b>fin sets</b> are represented with a continuous blue line; the rocket's <b>inner components</b> are represented with a continuous red line (the <b>inner tube</b> is also filled in with a grey background); and the <b>mass objects</b> are represented with either black or red dotted lines. It is also possible to customize the colour in which each part is represented, as will be shown later on. The image below shows how the top left-hand portion of the <i>Rocket design</i> window looks after the rocket design has been completed.
It is possible to customize the colour in which each part is represented, as will be shown later on.
 
The image below shows how the top left-hand portion of the <i>Rocket design</i> window looks like after the rocket design has been completed.
 
  
 
[[File:Structure.png|thumb|1000 px|center|Top left-hand portion of the <i>Rocket design</i> window after completing the rocket's design (taken from the <i>A simple model rocket</i> example design).]]
 
[[File:Structure.png|thumb|1000 px|center|Top left-hand portion of the <i>Rocket design</i> window after completing the rocket's design (taken from the <i>A simple model rocket</i> example design).]]
  
 
As you can see, the rocket's components have a tree-like structure: <br />
 
As you can see, the rocket's components have a tree-like structure: <br />
- the <b>Rocket</b>, called <i>A simple model rocket</i>, has only one stage, i.e. the <b>Sustainer</b>. <br />
+
- the <b>Rocket</b>, called <i>A simple model rocket</i>, has only one stage: the <b>Sustainer</b>. <br />
- the <b>Sustainer</b> contains two <b>body components</b>, i.e. a <b>Nose cone</b> and a <b>Body tube</b>. <br />
+
- the <b>Sustainer</b> contains two <b>body components</b>a <b>Nose cone</b> and a <b>Body tube</b>. <br />
 
- the <b>Body tube</b> contains a <b>fin set</b> (in particular a <b>Trapezoidal fin set</b>), a <b>Launch lug</b>, three <b>inner components</b> (an <b>Inner Tube</b> and two <b>Centering rings</b>), and three <b>mass objects</b> (a <b>Shock cord</b>, a <b>Parachute</b>, and a <b>Wadding</b>). <br />
 
- the <b>Body tube</b> contains a <b>fin set</b> (in particular a <b>Trapezoidal fin set</b>), a <b>Launch lug</b>, three <b>inner components</b> (an <b>Inner Tube</b> and two <b>Centering rings</b>), and three <b>mass objects</b> (a <b>Shock cord</b>, a <b>Parachute</b>, and a <b>Wadding</b>). <br />
 
- the <b>Inner tube</b> contains an <b>Engine block</b>. <br />
 
- the <b>Inner tube</b> contains an <b>Engine block</b>. <br />
More on this tree-like structure will be said later on. <br />
+
This tree-like structure will be discussed further later in this guide. <br /><br />
The buttons visible on the left in the previous image have pretty staightforward functions: by selecting one of the rocket's components you can change its position in the list of components (<b>not</b> its position in the rocket) by using the <i>Move up</i> and <i>Move down</i> buttons, edit its characteristics (e.g. dimensions, material, mass, colour used to represent it within the rocket) by using the <i>Edit</i> button, or delete it from the rocket using the <i>Delete</i> button. Notice that none of these buttons is active in the above image, since no component has been selected.<br />
+
 
You can also add an extra stage to you rocket by clicking the <i>New stage</i> button.  
+
The buttons visible on the left in the previous image have pretty straightforward functions. By selecting one of the rocket's components you can change its position in the list of components (but <b>not</b> its position in the rocket) by using the <i>Move up</i> and <i>Move down</i> buttons. You can also edit its characteristics (e.g., dimensions, material, mass, colour used to represent it within the rocket) by using the <i>Edit</i> button--or you can delete it from the rocket completely using the <i>Delete</i> button. Notice that none of these buttons is active in the above image, since no component has been selected.<br /><br />
 +
 
 +
You can also add an extra stage to your rocket by clicking the <i>New stage</i> button.  
  
  
 
=== The <i>Flight simulations</i> window ===
 
=== The <i>Flight simulations</i> window ===
  
Now we have a look at the <i>Flight simulations</i> window, which you can access by selecting the <i>Flight simulations</i> tab in the top left-hand corner of the <i>Openrocket main window</i>.
+
Now we have a look at the <i>Flight simulations</i> window, which you can access by selecting the <i>Flight simulations</i> tab in the top left-hand corner of the <i>OpenRocket main window</i>. Before designing your rocket or running any flight simulation, the <i>Flight simulations</i> window looks like this:
Before designing your rocket or running any flight simulation, the <i>Flight simulations</i> window looks like this:
 
  
 
[[File:Empty_simulations.png|thumb|800 px|center|The <i>Flight simulations</i> window before designing the rocket and running any simulation.]]
 
[[File:Empty_simulations.png|thumb|800 px|center|The <i>Flight simulations</i> window before designing the rocket and running any simulation.]]
  
Notice that the bottom part of the window does not change when switching from the <i>Rocket Design</i> window to the <i>Flight simulations</i> window. <br />
+
Notice that the bottom part of the window does not change when switching from the <i>Rocket Design</i> window to the <i>Flight simulations</i> window. Hence we only need to analyze the top part of the window. Here, most of the space is occupied by a currently blank space, where the technical details about your simulations will appear. Above this space there are five buttons, which allow you to <b>program a new simulation</b> (<i>New simulation</i>), <b>edit a selected simulation</b> (<i>Edit simulation</i>), for example by changing motor configuration or some atmospheric condition, <b>run all the simulations you have programmed</b> (<i>Run simulations</i>), <b>remove the selected simulations</b> (<i>Remove simulations</i>), or either <b>plot or export some of the results of a selected simulation</b>(<i>Plot/export</i>). (More on exporting simulation results in [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Rocket_Analysis Section 8].)<br /> <br />
Hence we only need to analyse the top part of the window. Here, most of the space is occupied by a currently blank space, where the technical details about your simulations will appear. Above this space there are five buttons, which allow you to <b>program a new simulation</b> (<i>New simulation</i>), <b>edit a selected simulation</b> (<i>Edit simulation</i>), for example by changing motor configuration or some atmospheric condition, <b>run all the simulations you have programmed</b> (<i>Run simulations</i>), <b>remove the selected simulations</b> (<i>Remove simulations</i>), or either <b>plot or export some of the results of a selected simulation</b>(<i>Plot/export</i>). <br />
 
More on exporting simulation results in [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Rocket_Analysis Section 8]. <br />
 
  
The image below shows how the top part of the <i>Rocket Design</i> window looks like after you have designed your rocket, programmed some simulations and run them.
+
The image below shows how the top part of the <i>Rocket Design</i> window looks after you have designed your rocket, programmed some simulations and run them.
  
 
[[File:Simulations.png|thumb|1000 px|center|The top half of the <i>Flight simulations</i> window after having programmed and run some simulations (taken from the <i>A simple model rocket</i> example design).]]
 
[[File:Simulations.png|thumb|1000 px|center|The top half of the <i>Flight simulations</i> window after having programmed and run some simulations (taken from the <i>A simple model rocket</i> example design).]]
 
+
<br/>
Notice that five of the six simulations that have been run have a green tick on the left: this means that the simulation has been completed without any <b>warnings</b>. Conversely, if the simulation has been completed with some <b>warning</b>, a red exclamation mark is shown (as for the third simulation in the image above). To find out the more about the warning, position your mouse over the simulation, without clicking, as shown in the image below.
+
Notice that five of the six simulations that have been run have a green tick on the left: this means that the simulation has been completed without any <b>warnings</b>. Conversely, if the simulation has generated some <b>warning</b> while being run, a red exclamation mark is shown (as for the third simulation in the image above). To find out the more about the warning, mouse-over the simulation (without clicking) as shown in the image below.
  
 
[[File:Warning.png|thumb|1000 px|center|More information about <b>warnings</b> in the <i>Flight simulations</i> window.]]
 
[[File:Warning.png|thumb|1000 px|center|More information about <b>warnings</b> in the <i>Flight simulations</i> window.]]
 
+
<br/>
It is possible to change the position of the columns containing the various technical information about the simulations simply by dragging any column left of right, as shown below:
+
It is possible to change the position of the columns containing the various technical simulation data by simply dragging any column left or right, as shown below:
  
 
[[File:Columns.png|thumb|1000 px|center|Moving columns in the <i>Flight simulations</i> window.]]
 
[[File:Columns.png|thumb|1000 px|center|Moving columns in the <i>Flight simulations</i> window.]]
Line 100: Line 96:
 
== The <i>main window</i>'s menus ==
 
== The <i>main window</i>'s menus ==
  
We now analyse the four <i>main window</i>'s menus, briefly explaining the function of each of the menus' options.
+
We now analyze the four <i>main window</i>'s menus, briefly explaining the function of each of the menus' options.
  
  
 
=== The <i>File</i> menu ===
 
=== The <i>File</i> menu ===
  
The image below shows the options offered by the <b><i>File</i></b> menu, located in the top left-hand corner of Openrocket's <i>main window</i>.
+
The image below shows the options offered by the <b><i>File</i></b> menu, located in the top left-hand corner of OpenRocket's <i>main window</i>.
  
 
[[File:File.png|thumb|1000 px|center|The <i>File</i> menu.]]
 
[[File:File.png|thumb|1000 px|center|The <i>File</i> menu.]]
Line 111: Line 107:
 
The function of each option in the <i>File</i> menu is pretty straightforward to understand: <br />
 
The function of each option in the <i>File</i> menu is pretty straightforward to understand: <br />
 
- <b><i>New</i></b> allows you to start a new project, without closing the project that is currently open. <br />
 
- <b><i>New</i></b> allows you to start a new project, without closing the project that is currently open. <br />
- <b><i>Open...</i></b> allows you to open a <i>*.ork</i> file you have saved on your computer. <br />
+
- <b><i>Open...</i></b> allows you to open a <i>*.ork</i> file that you have saved on your computer. <br />
 
- <b><i>Open example...</i></b> allows you to open one of the example projects (more on these later). <br />
 
- <b><i>Open example...</i></b> allows you to open one of the example projects (more on these later). <br />
- <b><i>Save</i></b> saves the changes you have made to a previously saved projects. <br />
+
- <b><i>Save</i></b> saves the changes you have made to a previously-saved project. <br />
 
- <b><i>Save as...</i></b> allows you to save the project you are working on to a new <i>*.ork</i> file. <br />
 
- <b><i>Save as...</i></b> allows you to save the project you are working on to a new <i>*.ork</i> file. <br />
- <b><i>Print/Export PDF</i></b> opens a window like the one shown below (if you have already completed your rocket's design). From here you can select what to include in your print/PDF file, e.g. technical detais of your rocket's components, temmplates of your rocket's fin sets, the design of your rocket. We suggest you try this option with one of the example projects to understand how each of these is represented when printing/exporting to PDF. More on printing and exporting to PDF in [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Rocket_Analysis Section 8].
+
- <b><i>Print/Export PDF</i></b> opens a window like the one shown below (if you have already completed your rocket's design). From here you can select what to include in your print/PDF file; such as technical details of your rocket's components, templates of your rocket's fin sets or even the design of your rocket. We suggest you try this option with one of the example projects to understand how each of these is represented when printing/exporting to PDF. More on printing and exporting to PDF in [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Rocket_Analysis Section 8].
 
<br />
 
<br />
- <b><i>Close</i></b> closes the project you are currently working on (after asking you whether you want to save the project if you haven't already done so) and exits the application if it was the only open project. <br />
+
- <b><i>Close</i></b> closes the current project (after asking for confirmation if there are unsaved changes). This will also exit the application if there was only one project open. <br />
 
- <b><i>Quit</i></b> exits the application, checking that you have saved all open projects.
 
- <b><i>Quit</i></b> exits the application, checking that you have saved all open projects.
  
Line 129: Line 125:
 
[[File:Edit.png|thumb|1000 px|center|The <i>Edit</i> menu.]]
 
[[File:Edit.png|thumb|1000 px|center|The <i>Edit</i> menu.]]
  
These options are mostly the classic editing options, i.e. undo/redo some action (<b><i>Undo</i></b>/<b><i>Redo</i></b>) and cut/copy/paste/delete some element (<b><i>Cut</i></b>/<b><i>Copy</i></b>/<b><i>Paste</i></b>/<b><i>Delete</i></b>). <br />
+
These options are mostly the classic editing options: undo/redo some action (<b><i>Undo</i></b>/<b><i>Redo</i></b>) and cut/copy/paste/delete some element (<b><i>Cut</i></b>/<b><i>Copy</i></b>/<b><i>Paste</i></b>/<b><i>Delete</i></b>). We also have the following options: <br />
We also have the following options: <br />
+
- <b><i>Scale...</i></b> opens the window shown below. Here you can choose to scale your rocket's size by some percentage (you can select from a range of 25% to 400%), starting from a specified dimension that can either be the one the rocket currently has or one you specify. By checking or unchecking the <i>Update explicit mass values</i> box, you can also decide whether or not the rocket's mass should be updated when scaling its volume.
- <b><i>Scale...</i></b> opens the window shown below. Here you can choose to scale your rocket's size by some percentage (you can select in a range from 25% to 400%) starting from a specified dimension (which can either be the one the rocket currently has or one you specify). By checking/unchecking the <i>Update explicit mass values</i> you can also decide whether the rocket's mass should be updated or not when scaling the rocket's volume.
 
  
 
[[File:Scale.png|thumb|1000 px|center|The <i>Scale</i> window.]]
 
[[File:Scale.png|thumb|1000 px|center|The <i>Scale</i> window.]]
  
- <b><i>Preferences</i></b> opens the <i>Preferences</i> window, shown below. At the top of this window there are three tabs, which allow you to switch between <b><i>Units</i></b>, <b><i>Materials</i></b>, and <b><i>Options</i></b>. We consider the <i>Units</i> tab (shown in the picture below) of the <i>Preferences</i> window first. Here you can set the units for each individual physical quantity or set all units either to the <i>Default metric</i> or to the <i>Default imperial</i>.
+
- <b><i>Preferences</i></b> opens the <i>Preferences</i> window, as shown below. At the top of this window there are three tabs which allow you to switch between <b><i>Units</i></b>, <b><i>Materials</i></b>, and <b><i>Options</i></b>. We will first consider the <i>Units</i> tab (shown in the picture below). Here you can set the units for each individual physical quantity, or set all units either to the <i>Default metric</i> or to the <i>Default imperial</i> settings.
  
 
[[File:Preferences.png|thumb|1000 px|center|The <i>Units</i> tab of the <i>Preferences</i> window.]]
 
[[File:Preferences.png|thumb|1000 px|center|The <i>Units</i> tab of the <i>Preferences</i> window.]]
  
The picture below shows the <i>Materials</i> tab of the <i>Preferences</i> window. Here you can manage all the available materials for the rocket component, by either <b>editing the characteristics</b> of the materials (i.e. their name and density) through the <i>Edit</i> button or <b>deleting</b> some material through the <i>Delete</i> button. You can also <b>add new materials</b> if you wish, by clicking the <i>New</i> button and setting the material's name, type, and density.
+
The picture below shows the <i>Materials</i> tab of the <i>Preferences</i> window. Here you can manage all of the available materials for the rocket component, by either <b>editing the characteristics</b> of the materials (i.e., their name and density) through the <i>Edit</i> button, or you can <b>delete</b> a material through the <i>Delete</i> button. You can also <b>add new materials</b> if you wish, by clicking the <i>New</i> button and setting the material's name, type and density.
  
 
[[File:Materials.png|thumb|1000 px|center|The <i>Materials</i> tab of the <i>Preferences</i> window.]]
 
[[File:Materials.png|thumb|1000 px|center|The <i>Materials</i> tab of the <i>Preferences</i> window.]]
  
Finally, the picture below shows the <i>Options</i> tab of the <i>Preferences</i> window. Using the drop-down lists you can <b>set the application's language</b>, <b>determine where to insert new rocket components</b>, choose whether or not to <b>ask a confirm when deleting simulations</b>, and <b>load some of your own <i>thrust curves</i></b>.  
+
Finally, the picture below shows the <i>Options</i> tab of the <i>Preferences</i> window. Using the provided drop-down lists you can <b>set the application's language</b>, <b>determine where to insert new rocket components</b>, choose whether or not to <b>ask for confirmation when deleting simulations</b>, or <b>load some of your own <i>thrust curves</i></b>.  
  
 
[[File:Options.png|thumb|1000 px|center|The <i>Options</i> tab of the <i>Preferences</i> window.]]
 
[[File:Options.png|thumb|1000 px|center|The <i>Options</i> tab of the <i>Preferences</i> window.]]
Line 154: Line 149:
 
[[File:Analyze.png|thumb|1000 px|center|The <i>Analyze</i> menu.]]
 
[[File:Analyze.png|thumb|1000 px|center|The <i>Analyze</i> menu.]]
  
- The <b><i>Component analysis</i></b> option opens a window like the one shown below. Here, techical information for the rocket's <b>external components</b> and fin sets is shown. Using the scroll bars in the top half of the window you can also change some parameters, such as <b>wind direction</b>, <b>angle of attachment</b>, <b>mach number</b>, and <b>roll rate</b>. <br />
+
- The <b><i>Component analysis</i></b> option opens a window like the one shown below. Here, technical information for the rocket's <b>external components</b> and fin sets is displayed. Using the scroll bars in the top half of the window you can also change some parameters, such as <b>wind direction</b>, <b>angle of attachment</b>, <b>mach number</b> and <b>roll rate</b>. More on the <i>component analysis</i> window in [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Rocket_Analysis Section 8].
More on the <i>component analysis</i> window in [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Rocket_Analysis Section 8].
 
  
 
[[File:Component analysis.png|thumb|1000 px|center|The <i>Component analysis</i> window, opened from the <i>A simple model rocket</i> example design.]]
 
[[File:Component analysis.png|thumb|1000 px|center|The <i>Component analysis</i> window, opened from the <i>A simple model rocket</i> example design.]]
  
- The <b><i>Rocket optimization</i></b> option opens a window like the one shown below. From here you can optimize the performance of your rocket (select exactly which performance to optimize from the <b><i>Optimized</i></b> drop-down list). <br />
+
- The <b><i>Rocket optimization</i></b> option opens a window like the one shown below. From here you can optimize the performance of your rocket by selecting exactly which performance to optimize from the <b><i>Optimized</i></b> drop-down list. More on the <i>rocket optimization</i> window in [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Rocket_Analysis Section 8].
More on the <i>rocket optimization</i> window in [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Rocket_Analysis Section 8].
 
  
 
[[File:Optimization.png|thumb|800 px|center|The <i>Optimization</i> window, opened from the <i>A simple model rocket</i> example design.]]
 
[[File:Optimization.png|thumb|800 px|center|The <i>Optimization</i> window, opened from the <i>A simple model rocket</i> example design.]]
Line 170: Line 163:
 
[[File:Help.png|thumb|1000 px|center|The <i>Help</i> menu.]]
 
[[File:Help.png|thumb|1000 px|center|The <i>Help</i> menu.]]
  
<b>NOTE: The guided tour option is a planned feature, but is not yet implemented into Openrocket. Hence for the moment you will not find it in the <i>Help</i> menu.</b> <br />
+
<b>NOTE: The guided tour option is a planned feature, but is not yet implemented in OpenRocket. Therefore for the moment you will not find it in the <i>Help</i> menu.</b> <br />
 
The functions of the options in the <i>Help</i> menu are as follow: <br />
 
The functions of the options in the <i>Help</i> menu are as follow: <br />
- <b><i>License</i></b> opens a window containing Openrocket's license. <br />
+
- <b><i>License</i></b> opens a window containing OpenRocket's license. <br />
- <b><i>Bug report</i></b> opens a bug report form that you can complete and send to us. <br />
+
- <b><i>Bug report</i></b> opens a bug report form that you can complete and submit to the developers. <br />
- <b><i>Debug log</i></b> opens the Openrocket debug log. <br />
+
- <b><i>Debug log</i></b> opens the OpenRocket debug log. <br />
 
- <b><i>About</i></b> opens a window containing summary information about this project. <br />
 
- <b><i>About</i></b> opens a window containing summary information about this project. <br />
  
 
= The Example projects =
 
= The Example projects =
  
By now you should have a good idea of how Openrocket's user interface is structured. <br />
+
By now you should have a good idea of how OpenRocket's user interface is structured, so you might feel ready to start designing your own rocket (see next section)--and probably you are indeed ready. Nonetheless we suggest you have a look at some pre-designed example rockets that we have provided. To do this, simply select <i>File</i> -> <i>Open example...</i> and the window shown in the image below will appear.
So you might feel ready to start designing your own rocket (see next section), and probably you are indeed ready. <br />
 
Nonetheless we suggest you have a look at some example pre-designed rockets that we provide. To do this, simply select <i>File</i> -> <i>Open example...</i> and the window shown in the image below will appear.
 
  
 
[[File:Example.png|thumb|1000 px|center|The <i>Open example design</i> window.]]
 
[[File:Example.png|thumb|1000 px|center|The <i>Open example design</i> window.]]
  
Select one or more of the listed rockets (we suggest you start with <i>A simple model rocket</i>.) and then click <i>Open</i>. <br />
+
Select one or more of the listed rockets (we suggest that you start with <i>A simple model rocket</i>), then click <i>Open</i>. Now have a closer look at the various windows discussed in this section, and note how they change when you choose another example project. This should give you an idea of how to best use this application, and maybe even give you some new ideas for your future rockets! <br /><br />
Now have a closer look at the various windows we have analysed in this section, and see how they change when you choose another example project. This should give you an idea of how to use this application at its best, and maybe even give you some new ideas for your future rockets. <br />
+
 
<br />
+
Now that you know how this program is structured, you can <b>start using OpenRocket to design your own rockets</b>. How to do this will be the topic of the [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Basic_Rocket_Design next section].
Now that you know how this program is structured, you can <b>start using Openrocket to design your own rocket</b>. How to do this will be the topic of the [https://sourceforge.net/apps/mediawiki/openrocket/index.php?title=Basic_Rocket_Design next section].
 
  
 
----
 
----

Revision as of 08:56, 13 September 2015

↑ Back to Contents

The current User's Guide is very much a work in progress, any help would be greatly appreciated!
If you'd like to contribute something, just hit the 'Edit' tab at the top.


In this section we have a look at how OpenRocket is organized, by analyzing in detail the structure of the user interface. We will also briefly mention the Example projects that are accessible from the File menu. After reading this section you will have a thorough understanding of how OpenRocket is structured, and will be ready to start designing a rocket of your own. If you already know how this program is organized, feel free to jump to the next section.


The User interface

In this subsection we first briefly discuss the Rocket Configuration window, and then OpenRocket's main window and the main window's four menus.


The Rocket Configuration window

When you start a new project, you will be prompted with the following window:

The Rocket Configuration window.

Fill in the four fields (or you can leave all, except the Design name, blank if you wish), and click the close button.


OpenRocket's main window

You now have access to the OpenRocket main window.

The OpenRocket main window.

Notice there are two tabs in the top-left corner of the window, just under the menu options. These tabs allow you to switch between the Rocket design and Flight simulations windows.


The Rocket design window

For the moment, let's focus on the Rocket design window. This window is organized in the following way:
- in the bottom half of the window there is a large white space. This is where a 2D image of the rocket you are designing will appear.
- in the top-left part of the window, the rocket's stages and components are shown. When you start a new project, the rocket contains only one stage (i.e.; the sustainer) but no components.
- in the top-right part of the window, all the body components and fin sets, inner components, and mass objects that you can add to the rocket are shown. Notice that it's not possible to add all of these object to the rocket at any particular stage of the rocket design. Exactly which components can be added when will be explained later in this guide.

Now let's have a closer look at the bottom half of the Rocket design window. When you add a component to your rocket, it will be immediately displayed, as shown below:

Bottom half of the Rocket design window after adding a nose cone.

Notice the rulers around the borders. These give you an idea of the dimensions of your rocket.

As you can see, in addition to the appearance of your rocket, the Rocket design window also shows some other useful information as well. This includes the rocket's dimensions, mass, apogee, max. velocity, max. acceleration, stability, center of gravity (CG), and center of pressure (CP).

In the top left-hand corner of the previous image there are two buttons: Side view and Back view. These allow you to visualize the rocket from two different positions. Next to these buttons you can find the zoom-regulation commands and then one Stage i button for each Stage in your rocket. Selecting/deselecting each of these allows you to include or exclude each stage from the picture. On the left of the previous image you can also see a scroll bar that allows you to rotate the rocket up to 360°.

Finally, notice the drop-down list in the top right-hand corner of the previous image. This allows you to choose which of your motor configurations to apply to the rocket you have designed (more on this later). The image below shows how the bottom half of the Rocket design window appears after the rocket design has been completed.

Bottom half of the Rocket design window after completing the rocket's design (taken from the A simple model rocket example design).

In this image, the rocket's body components and fin sets are represented with a continuous blue line; the rocket's inner components are represented with a continuous red line (the inner tube is also filled in with a grey background); and the mass objects are represented with either black or red dotted lines. It is also possible to customize the colour in which each part is represented, as will be shown later on. The image below shows how the top left-hand portion of the Rocket design window looks after the rocket design has been completed.

Top left-hand portion of the Rocket design window after completing the rocket's design (taken from the A simple model rocket example design).

As you can see, the rocket's components have a tree-like structure:
- the Rocket, called A simple model rocket, has only one stage: the Sustainer.
- the Sustainer contains two body components: a Nose cone and a Body tube.
- the Body tube contains a fin set (in particular a Trapezoidal fin set), a Launch lug, three inner components (an Inner Tube and two Centering rings), and three mass objects (a Shock cord, a Parachute, and a Wadding).
- the Inner tube contains an Engine block.
This tree-like structure will be discussed further later in this guide.

The buttons visible on the left in the previous image have pretty straightforward functions. By selecting one of the rocket's components you can change its position in the list of components (but not its position in the rocket) by using the Move up and Move down buttons. You can also edit its characteristics (e.g., dimensions, material, mass, colour used to represent it within the rocket) by using the Edit button--or you can delete it from the rocket completely using the Delete button. Notice that none of these buttons is active in the above image, since no component has been selected.

You can also add an extra stage to your rocket by clicking the New stage button.


The Flight simulations window

Now we have a look at the Flight simulations window, which you can access by selecting the Flight simulations tab in the top left-hand corner of the OpenRocket main window. Before designing your rocket or running any flight simulation, the Flight simulations window looks like this:

The Flight simulations window before designing the rocket and running any simulation.

Notice that the bottom part of the window does not change when switching from the Rocket Design window to the Flight simulations window. Hence we only need to analyze the top part of the window. Here, most of the space is occupied by a currently blank space, where the technical details about your simulations will appear. Above this space there are five buttons, which allow you to program a new simulation (New simulation), edit a selected simulation (Edit simulation), for example by changing motor configuration or some atmospheric condition, run all the simulations you have programmed (Run simulations), remove the selected simulations (Remove simulations), or either plot or export some of the results of a selected simulation(Plot/export). (More on exporting simulation results in Section 8.)

The image below shows how the top part of the Rocket Design window looks after you have designed your rocket, programmed some simulations and run them.

The top half of the Flight simulations window after having programmed and run some simulations (taken from the A simple model rocket example design).


Notice that five of the six simulations that have been run have a green tick on the left: this means that the simulation has been completed without any warnings. Conversely, if the simulation has generated some warning while being run, a red exclamation mark is shown (as for the third simulation in the image above). To find out the more about the warning, mouse-over the simulation (without clicking) as shown in the image below.

More information about warnings in the Flight simulations window.


It is possible to change the position of the columns containing the various technical simulation data by simply dragging any column left or right, as shown below:

Moving columns in the Flight simulations window.


The main window's menus

We now analyze the four main window's menus, briefly explaining the function of each of the menus' options.


The File menu

The image below shows the options offered by the File menu, located in the top left-hand corner of OpenRocket's main window.

The File menu.

The function of each option in the File menu is pretty straightforward to understand:
- New allows you to start a new project, without closing the project that is currently open.
- Open... allows you to open a *.ork file that you have saved on your computer.
- Open example... allows you to open one of the example projects (more on these later).
- Save saves the changes you have made to a previously-saved project.
- Save as... allows you to save the project you are working on to a new *.ork file.
- Print/Export PDF opens a window like the one shown below (if you have already completed your rocket's design). From here you can select what to include in your print/PDF file; such as technical details of your rocket's components, templates of your rocket's fin sets or even the design of your rocket. We suggest you try this option with one of the example projects to understand how each of these is represented when printing/exporting to PDF. More on printing and exporting to PDF in Section 8.
- Close closes the current project (after asking for confirmation if there are unsaved changes). This will also exit the application if there was only one project open.
- Quit exits the application, checking that you have saved all open projects.

The window that opens when Print/Export PDF is selected.


The Edit menu

The image below shows the options offered by the Edit menu.

The Edit menu.

These options are mostly the classic editing options: undo/redo some action (Undo/Redo) and cut/copy/paste/delete some element (Cut/Copy/Paste/Delete). We also have the following options:
- Scale... opens the window shown below. Here you can choose to scale your rocket's size by some percentage (you can select from a range of 25% to 400%), starting from a specified dimension that can either be the one the rocket currently has or one you specify. By checking or unchecking the Update explicit mass values box, you can also decide whether or not the rocket's mass should be updated when scaling its volume.

The Scale window.

- Preferences opens the Preferences window, as shown below. At the top of this window there are three tabs which allow you to switch between Units, Materials, and Options. We will first consider the Units tab (shown in the picture below). Here you can set the units for each individual physical quantity, or set all units either to the Default metric or to the Default imperial settings.

The Units tab of the Preferences window.

The picture below shows the Materials tab of the Preferences window. Here you can manage all of the available materials for the rocket component, by either editing the characteristics of the materials (i.e., their name and density) through the Edit button, or you can delete a material through the Delete button. You can also add new materials if you wish, by clicking the New button and setting the material's name, type and density.

The Materials tab of the Preferences window.

Finally, the picture below shows the Options tab of the Preferences window. Using the provided drop-down lists you can set the application's language, determine where to insert new rocket components, choose whether or not to ask for confirmation when deleting simulations, or load some of your own thrust curves.

The Options tab of the Preferences window.


The Analyze menu

The image below shows the options offered by the Analyze menu.

The Analyze menu.

- The Component analysis option opens a window like the one shown below. Here, technical information for the rocket's external components and fin sets is displayed. Using the scroll bars in the top half of the window you can also change some parameters, such as wind direction, angle of attachment, mach number and roll rate. More on the component analysis window in Section 8.

The Component analysis window, opened from the A simple model rocket example design.

- The Rocket optimization option opens a window like the one shown below. From here you can optimize the performance of your rocket by selecting exactly which performance to optimize from the Optimized drop-down list. More on the rocket optimization window in Section 8.

The Optimization window, opened from the A simple model rocket example design.

The Help menu

The image below shows the options offered by the Help menu.

The Help menu.

NOTE: The guided tour option is a planned feature, but is not yet implemented in OpenRocket. Therefore for the moment you will not find it in the Help menu.
The functions of the options in the Help menu are as follow:
- License opens a window containing OpenRocket's license.
- Bug report opens a bug report form that you can complete and submit to the developers.
- Debug log opens the OpenRocket debug log.
- About opens a window containing summary information about this project.

The Example projects

By now you should have a good idea of how OpenRocket's user interface is structured, so you might feel ready to start designing your own rocket (see next section)--and probably you are indeed ready. Nonetheless we suggest you have a look at some pre-designed example rockets that we have provided. To do this, simply select File -> Open example... and the window shown in the image below will appear.

The Open example design window.

Select one or more of the listed rockets (we suggest that you start with A simple model rocket), then click Open. Now have a closer look at the various windows discussed in this section, and note how they change when you choose another example project. This should give you an idea of how to best use this application, and maybe even give you some new ideas for your future rockets!

Now that you know how this program is structured, you can start using OpenRocket to design your own rockets. How to do this will be the topic of the next section.


↑ Back to Contents