summaryrefslogtreecommitdiffstats
path: root/doc/kstars/calc-planetcoords.docbook
diff options
context:
space:
mode:
Diffstat (limited to 'doc/kstars/calc-planetcoords.docbook')
-rw-r--r--doc/kstars/calc-planetcoords.docbook47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/kstars/calc-planetcoords.docbook b/doc/kstars/calc-planetcoords.docbook
new file mode 100644
index 00000000..11b579eb
--- /dev/null
+++ b/doc/kstars/calc-planetcoords.docbook
@@ -0,0 +1,47 @@
+<sect2 id="calc-planetcoords">
+<title>Planet Coordinates module</title>
+<indexterm><primary>Tools</primary>
+<secondary>Astrocalculator</secondary>
+<tertiary>Planet Coordinates module</tertiary>
+</indexterm>
+
+<screenshot>
+<screeninfo>
+The Planet Coordinates calculator module
+</screeninfo>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="calc-planetcoords.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Planet Coordinates</phrase>
+ </textobject>
+</mediaobject>
+</screenshot>
+
+<para>
+The Planet Coordinates module computes positional data for
+any major solar system body, for any time and date and any
+geographic location. Simply select the <guilabel>solar
+system body</guilabel> from the drop-down list, and specify
+the desired date, time, and geographic coordinates (these
+values are preset to the current &kstars; settings). Then
+press the <guibutton>Compute</guibutton> button to determine
+the <link linkend="equatorial">Equatorial</link>, <link
+linkend="horizontal">Horizontal</link>, and <link
+linkend="ecliptic">Ecliptic</link> coordinates of the body.
+</para>
+<para>
+There is a batch mode for this module. You must construct
+an input file in which each line specifies values for the
+input parameters (solar system body, date, time, longitude,
+and latitude). You may choose to specify a constant value
+for some of the parameters in the calculator window (these
+parameters should be skipped in the input file). You may
+also specify which of the output parameters (Equatorial,
+Horizontal, and Ecliptic coordinates) should be calculated.
+Finally, specify the input and output filenames, and press
+the <guibutton>Run</guibutton> button to generate the output
+file with the computed values.
+</para>
+</sect2>