diff options
Diffstat (limited to 'doc/kstars')
123 files changed, 8386 insertions, 0 deletions
diff --git a/doc/kstars/Makefile.am b/doc/kstars/Makefile.am new file mode 100644 index 00000000..da8216ae --- /dev/null +++ b/doc/kstars/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +KDE_MANS = AUTO diff --git a/doc/kstars/aavso.png b/doc/kstars/aavso.png Binary files differnew file mode 100644 index 00000000..4d9db1a1 --- /dev/null +++ b/doc/kstars/aavso.png diff --git a/doc/kstars/ai-contents.docbook b/doc/kstars/ai-contents.docbook new file mode 100644 index 00000000..f7ee216c --- /dev/null +++ b/doc/kstars/ai-contents.docbook @@ -0,0 +1,45 @@ +<sect1 id="ai-contents"> +<title>AstroInfo: Table of Contents</title> + +<itemizedlist><title>The Sky and Coordinate Systems</title> + <listitem><para><link linkend="ai-skycoords">Celestial Coordinate Systems</link></para></listitem> + <listitem><para><link linkend="ai-cequator">Celestial Equator</link></para></listitem> + <listitem><para><link linkend="ai-cpoles">Celestial Poles</link></para></listitem> + <listitem><para><link linkend="ai-csphere">Celestial Sphere</link></para></listitem> + <listitem><para><link linkend="ai-ecliptic">The Ecliptic</link></para></listitem> + <listitem><para><link linkend="ai-equinox">The Equinoxes</link></para></listitem> + <listitem><para><link linkend="ai-geocoords">Geographic Coordinates</link></para></listitem> + <listitem><para><link linkend="ai-greatcircle">Great Circles</link></para></listitem> + <listitem><para><link linkend="ai-horizon">The Horizon</link></para></listitem> + <listitem><para><link linkend="ai-hourangle">Hour Angle</link></para></listitem> + <listitem><para><link linkend="ai-meridian">Local Meridian</link></para></listitem> + <listitem><para><link linkend="ai-precession">Precession</link></para></listitem> + <listitem><para><link linkend="ai-zenith">The Zenith</link></para></listitem> +</itemizedlist> + +<itemizedlist><title>Time</title> + <listitem><para><link linkend="ai-julianday">Julian Day</link></para></listitem> + <listitem><para><link linkend="ai-leapyear">Leap Years</link></para></listitem> + <listitem><para><link linkend="ai-sidereal">Sidereal Time</link></para></listitem> + <listitem><para><link linkend="ai-timezones">Time Zones</link></para></listitem> + <listitem><para><link linkend="ai-utime">Universal Time</link></para></listitem> +</itemizedlist> + +<itemizedlist><title>Physics</title> + <listitem><para><link linkend="ai-blackbody">Blackbody Radiation</link></para></listitem> + <listitem><para><link linkend="ai-darkmatter">Dark Matter</link></para></listitem> + <listitem><para><link linkend="ai-flux">Flux</link></para></listitem> + <listitem><para><link linkend="ai-luminosity">Luminosity</link></para></listitem> + <listitem><para><link linkend="ai-parallax">Parallax</link></para></listitem> + <listitem><para><link linkend="ai-retrograde">Retrograde Motion</link></para></listitem> +</itemizedlist> + +<itemizedlist><title>Astrophysics</title> + <listitem><para><link linkend="ai-ellipgal">Elliptical Galaxies</link></para></listitem> + <listitem><para><link linkend="ai-spiralgal">Spiral Galaxies</link></para></listitem> + <listitem><para><link linkend="ai-magnitude">The Magnitude Scale</link></para></listitem> + <listitem><para><link linkend="ai-stars">Stars: An Introductory FAQ</link></para></listitem> + <listitem><para><link linkend="ai-colorandtemp">Star Colors and Temperatures</link></para></listitem> +</itemizedlist> + +</sect1> diff --git a/doc/kstars/alpha.png b/doc/kstars/alpha.png Binary files differnew file mode 100644 index 00000000..8c452aac --- /dev/null +++ b/doc/kstars/alpha.png diff --git a/doc/kstars/altvstime.docbook b/doc/kstars/altvstime.docbook new file mode 100644 index 00000000..0438b0cb --- /dev/null +++ b/doc/kstars/altvstime.docbook @@ -0,0 +1,90 @@ +<sect1 id="tool-altvstime"> +<title>Altitude vs. Time Tool</title> +<indexterm><primary>Tools</primary> +<secondary>Altitude vs. Time Tool</secondary> +</indexterm> + +<screenshot> +<screeninfo> +The Altitude vs. Time Tool +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="altvstime.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Altitude vs. Time Plotter</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This tool plots the altitude of any objects as a function of time, +for any date and location on Earth. The top section is a graphical +plot of altitude angle on the vertical axis, and time on the horizontal +axis. The time is shown both as standard local time along the bottom, +and <link linkend="ai-sidereal">sidereal time</link> along the top. +The bottom half of the graph is shaded green to indicate that points +in this region are below the horizon. +</para> +<para> +There are a few ways to add curves to the plot. The simplest way to +add the curve of an existing object is to simply type its name in the +<guilabel>Name</guilabel> input field, and press Enter, or the +<guibutton>Plot</guibutton> button. If the text you enter is found in +the object database, the object's curve is added to the graph. You +can also press the <guibutton>Browse</guibutton> button to open the +<link linkend="findobjects">Find Object Window</link> to select an +object from the list of known objects. If you want to add a point +that does not exist in the object database, simply enter a name for +the point, and then fill in the coordinates in the +<guilabel>RA</guilabel> and <guilabel>Dec</guilabel> input fields. +Then press the <guibutton>Plot</guibutton> button to add the curve for +your custom object to the plot (note that you have to pick a name that +does not already exist in the object database for this to work). +</para> +<para> +When you add an object to the plot, its altitude vs. time curve is +plotted with a thick white line, and its name is added to the listbox +at the lower right. Any objects that were already present are plotted +with a thinner red curve. You can choose which object is plotted with +the thick white curve by highlighting its name in the listbox. +</para> +<para> +These curves show the objects' Altitude (angle above the <link +linkend="ai-horizon">horizon</link>) as a function of time. When +a curve passes from the lower half to the upper half, the object has +risen; when it falls back to the lower half, it has set. For example, +in the screenshot, the minor planet <firstterm>Quaoar</firstterm> is +setting at around 15:00 local time, and is rising at about 04:00 local +time. +</para> +<para> +The Altitude of an object depends on both where you are on Earth, and +on the Date. By default, the Tool adopts the Location and Date from the +current KStars settings. You can change these parameters in the +<guilabel>Date & Location</guilabel> Tab. To change the Location, +you can press the <guibutton>Choose City...</guibutton> button to open +the <link linkend="setgeo">Set Geographic Location</link> Window, or +enter Longitude and Latitude values manually in the input fields, and +press the <guibutton>Update</guibutton> button. To change the Date, +use the <guilabel>Date</guilabel> picker widget, then press +<guibutton>Update</guibutton>. Note that any curves you had already +plotted will be automatically updated when you change the Date and/or +Location. +</para> + +<tip> +<para>Exercise:</para> +<para> +Plot the Sun's Altitude curve. Make sure the geographic location is not +near the equator. Change the Date to some time in June, and then again to +sometime in January. You can see easily why we have seasons; in the +winter, the Sun is above the horizon for less time (the days are shorter), +and its altitude is never very high. +</para> +</tip> + + +</sect1> + diff --git a/doc/kstars/altvstime.png b/doc/kstars/altvstime.png Binary files differnew file mode 100644 index 00000000..d84ffae4 --- /dev/null +++ b/doc/kstars/altvstime.png diff --git a/doc/kstars/astroinfo.docbook b/doc/kstars/astroinfo.docbook new file mode 100644 index 00000000..e1ea7182 --- /dev/null +++ b/doc/kstars/astroinfo.docbook @@ -0,0 +1,48 @@ +<chapter id="astroinfo"> +<title>The AstroInfo Project</title> + +<para> +Here you can find a collection of short articles that explain various +astronomical concepts used in &kstars;. From coordinate systems to +celestial mechanics, you can find answers to your questions here. +</para><para> +The articles sometimes also contain exercises that you can perform with +&kstars; to illustrate the concept behind the article. +</para> + +&contents; <!--AstroInfo: Table of Contents--> + +&skycoords; <!--AstroInfo: Celestial Coordinate Systems--> +&cequator; <!--AstroInfo: Celestial Equator--> +&cpoles; <!--AstroInfo: Celestial Poles--> +&csphere; <!--AstroInfo: Celestial Sphere--> +&ecliptic; <!--AstroInfo: The Ecliptic--> +&equinox; <!--AstroInfo: The Equinoxes--> +&geocoords; <!--AstroInfo: Geographic Coordinates--> +&greatcircle; <!--AstroInfo: Great Circles--> +&horizon; <!--AstroInfo: Horizon--> +&hourangle; <!--AstroInfo: Hour Angle--> +&meridian; <!--AstroInfo: Local Meridian--> +&precession; <!--AstroInfo: Precession--> +&zenith; <!--AstroInfo: The Zenith--> + +&julianday; <!--AstroInfo: Julian Day--> +&leapyear; <!--AstroInfo: Leap Year--> +&sidereal; <!--AstroInfo: Sidereal Time--> +&timezones; <!--AstroInfo: Time zones--> +&utime; <!--AstroInfo: Universal Time--> + +&blackbody; <!--AstroInfo: Blackbody Radiation--> +&darkmatter; <!--AstroInfo: Dark Matter--> +&flux; <!--AstroInfo: Flux--> +&luminosity; <!--AstroInfo: Luminosity--> +¶llax; <!--AstroInfo: Parallax--> +&retrograde; <!--AstroInfo: Retrograde Motion--> + +&ellipgal; <!--Elliptical Galaxies--> +&spiralgal; <!--Spiral Galaxies--> +&magnitude; <!--AstroInfo: The Magnitude Scale--> +&stars; <!--AstroInfo: Stars: An Introductory FAQ--> +&colorandtemp; <!--AstroInfo: Star Colors and Temperatures--> + +</chapter> diff --git a/doc/kstars/blackbody.docbook b/doc/kstars/blackbody.docbook new file mode 100644 index 00000000..84b8ba3a --- /dev/null +++ b/doc/kstars/blackbody.docbook @@ -0,0 +1,169 @@ +<sect1 id="ai-blackbody"> + +<sect1info> + +<author> +<firstname>Jasem</firstname> +<surname>Mutlaq</surname> +<affiliation><address> +</address></affiliation> +</author> +</sect1info> + +<title>Blackbody Radiation</title> +<indexterm><primary>Blackbody Radiation</primary> +<seealso>Star Colors and Temperatures</seealso> +</indexterm> + +<para> +A <firstterm>blackbody</firstterm> refers to an opaque object that +emits <firstterm>thermal radiation</firstterm>. A perfect +blackbody is one that absorbs all incoming light and does not +reflect any. At room temperature, such an object would +appear to be perfectly black (hence the term +<emphasis>blackbody</emphasis>). However, if heated to a high +temperature, a blackbody will begin to glow with +<firstterm>thermal radiation</firstterm>. +</para> + +<para> +In fact, all objects emit thermal radiation (as long as their +temperature is above Absolute Zero, or -273.15 degrees Celsius), +but no object emits thermal radiation perfectly; rather, they are +better at emitting/absorbing some wavelengths of light than others. +These uneven efficiencies make it difficult to study the interaction +of light, heat and matter using normal objects. +</para> + +<para> +Fortunately, it is possible to construct a nearly-perfect blackbody. +Construct a box made of a thermally conductive material, such as +metal. The box should be completely closed on all sides, so that the +inside forms a cavity that does not receive light from the +surroundings. Then, make a small hole somewhere on the box. +The light coming out of this hole will almost perfectly resemble the +light from an ideal blackbody, for the temperature of the air inside +the box. +</para> + +<para> +At the beginning of the 20th century, scientists Lord Rayleigh, +and Max Planck (among others) studied the blackbody +radiation using such a device. After much work, Planck was able to +empirically describe the intensity of light emitted by a blackbody as a +function of wavelength. Furthermore, he was able to describe how this +spectrum would change as the temperature changed. Planck's work on +blackbody radiation is one of the areas of physics that led to the +foundation of the wonderful science of Quantum Mechanics, but that is +unfortunately beyond the scope of this article. +</para> + +<para> +What Planck and the others found was that as the temperature of a +blackbody increases, the total amount of light emitted per +second increases, and the wavelength of the spectrum's peak shifts to +bluer colors (see Figure 1). +</para> + +<para> +<mediaobject> +<imageobject> +<imagedata fileref="blackbody.png" format="PNG"/> +</imageobject> +<caption><para><phrase>Figure 1</phrase></para></caption> +</mediaobject> +</para> + +<para> +For example, an iron bar becomes orange-red when heated to high temperatures and its color +progressively shifts toward blue and white as it is heated further. +</para> + +<para> +In 1893, German physicist Wilhelm Wien quantified the relationship between blackbody +temperature and the wavelength of the spectral peak with the +following equation: +</para> + +<para> +<mediaobject> +<imageobject> +<imagedata fileref="lambda_max.png" format="PNG"/> +</imageobject> +</mediaobject> +</para> + +<para> +where T is the temperature in Kelvin. Wien's law (also known as +Wien's displacement law) states that the +wavelength of maximum emission from a blackbody is inversely +proportional to its temperature. This makes sense; +shorter-wavelength (higher-frequency) light corresponds to +higher-energy photons, which you would expect from a +higher-temperature object. +</para> + +<para> +For example, the sun has an average temperature of 5800 K, so +its wavelength of maximum emission is given by: + +<mediaobject> +<imageobject> +<imagedata fileref="lambda_ex.png" format="PNG"/> +</imageobject> +</mediaobject> +</para> + +<para> +This wavelengths falls in the +green region of the visible light spectrum, but the sun's continuum +radiates photons both longer and shorter than lambda(max) and the +human eyes perceives the sun's color as yellow/white. +</para> + +<para> +In 1879, Austrian physicist Stephan Josef Stefan showed that +the luminosity, L, of a black body is proportional to the 4th power of its temperature T. +</para> + +<para> +<mediaobject> +<imageobject> +<imagedata fileref="luminosity.png" format="PNG"/> +</imageobject> +</mediaobject> +</para> + +<para> +where A is the surface area, alpha is a constant of proportionality, +and T is the temperature in Kelvin. That is, if we double the +temperature (e.g. 1000 K to 2000 K) then the total energy radiated +from a blackbody increase by a factor of 2^4 or 16. +</para> + +<para> +Five years later, Austrian physicist Ludwig Boltzman derived the same +equation and is now known as the Stefan-Boltzman law. If we assume a +spherical star with radius R, then the luminosity of such a star is +</para> + +<para> +<mediaobject> +<imageobject> +<imagedata fileref="luminosity_ex.png" format="PNG"/> +</imageobject> +</mediaobject> +</para> + +<para> +where R is the star radius in cm, and the alpha is the +Stefan-Boltzman constant, which has the value: + +<mediaobject> +<imageobject> +<imagedata fileref="alpha.png" format="PNG"/> +</imageobject> +</mediaobject> +</para> + +</sect1> diff --git a/doc/kstars/blackbody.png b/doc/kstars/blackbody.png Binary files differnew file mode 100644 index 00000000..c08989b8 --- /dev/null +++ b/doc/kstars/blackbody.png diff --git a/doc/kstars/calc-angdist.docbook b/doc/kstars/calc-angdist.docbook new file mode 100644 index 00000000..7ccb1b04 --- /dev/null +++ b/doc/kstars/calc-angdist.docbook @@ -0,0 +1,43 @@ +<sect2 id="calc-angdist"> +<title>Angular Distance module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Angular Distance module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Angular Distance calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-angdist.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Angular Distance</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The Angular Distance tool is used to measure the angle between any +two points on the sky. You simply specify the +<link linkend="equatorial">Equatorial coordinates</link> of the +desired pair of points, and then press the +<guibutton>Compute</guibutton> button to obtain the angle between +the two points. +</para> +<para> +There is also a Batch mode for this module. In batch mode, you +specify an input filename which contains four numbers per line: +the RA and Dec values for pairs of points. Alternatively, you can +specify a single value for any of these four coordinates in +the calculator panel (the corresponding values in the input file +should be skipped if they are specified in the calculator). +</para> +<para> +Once you have specified the input filename and an output filename, +simply press the <guibutton>Run</guibutton> button to generate the +output file. +</para> +</sect2> diff --git a/doc/kstars/calc-angdist.png b/doc/kstars/calc-angdist.png Binary files differnew file mode 100644 index 00000000..3254671b --- /dev/null +++ b/doc/kstars/calc-angdist.png diff --git a/doc/kstars/calc-apcoords.docbook b/doc/kstars/calc-apcoords.docbook new file mode 100644 index 00000000..171eba09 --- /dev/null +++ b/doc/kstars/calc-apcoords.docbook @@ -0,0 +1,41 @@ +<sect2 id="calc-apcoords"> +<title>Apparent Coordinates module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Apparent Coordinates module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Apparent Coordinates calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-apcoords.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Apparent Coordinates</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The Apparent Coordinates module converts the <firstterm>catalog +coordinates</firstterm> of a point in the sky to its +<firstterm>apparent coordinates</firstterm> for any date. The +coordinates of objects in the sky are not fixed, because of +<link linkend="ai-precession">precession</link>, nutation and +aberration. This module takes these effects into account. +</para> +<para> +To use the module, first enter the desired target date and time +in the <guilabel>Target Time/Date</guilabel> section. Then, +enter the catalog coordinates in the <guilabel>Catalog +Coordinates</guilabel> section. You can also specify the +catalog's epoch here (usually 2000.0 for modern object +catalogs). Finally, press the <guibutton>Compute</guibutton> +button, and the object's coordinates for the target date +will be displayed in the <guilabel>Apparent Coordinates</guilabel> +section. +</para> +</sect2> diff --git a/doc/kstars/calc-apcoords.png b/doc/kstars/calc-apcoords.png Binary files differnew file mode 100644 index 00000000..5d54f3d3 --- /dev/null +++ b/doc/kstars/calc-apcoords.png diff --git a/doc/kstars/calc-dayduration.docbook b/doc/kstars/calc-dayduration.docbook new file mode 100644 index 00000000..c5c11117 --- /dev/null +++ b/doc/kstars/calc-dayduration.docbook @@ -0,0 +1,28 @@ +<sect2 id="calc-dayduration"> +<title>Day Duration module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Day Duration module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Day Duration calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-daylength.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Day Duration</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This module computes the length of day as well as sunrise, sun-transit +(noon), and sunset times for any calendar date, for any location on +Earth. First fill in the desired geographic coordinates and date, then +press the <guibutton>Compute</guibutton> button. +</para> +</sect2> diff --git a/doc/kstars/calc-daylength.png b/doc/kstars/calc-daylength.png Binary files differnew file mode 100644 index 00000000..c74d1560 --- /dev/null +++ b/doc/kstars/calc-daylength.png diff --git a/doc/kstars/calc-ecliptic.docbook b/doc/kstars/calc-ecliptic.docbook new file mode 100644 index 00000000..9117cd25 --- /dev/null +++ b/doc/kstars/calc-ecliptic.docbook @@ -0,0 +1,43 @@ +<sect2 id="calc-ecliptic"> +<title>Ecliptic Coordinates module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Ecliptic Coordinates module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Ecliptic Coordinates calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-ecliptic.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Ecliptic Coordinates</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This module converts between <link linkend="equatorial">Equatorial +coordinates</link> and <link linkend="ecliptic">Ecliptic +coordinates</link>. First, select which coordinates +should be taken as input values in the <guilabel>Choose Input +Coordinates</guilabel> section. Then, fill in the corresponding +coordinate values in either the <guilabel>Ecliptic +coordinates</guilabel> or <guilabel>Equatorial coordinates</guilabel> +section. Finally, press the <guibutton>Compute</guibutton> button, +and the complementary coordinates will be filled in. +</para> +<para> +The module contains a batch mode for converting several coordinate +pairs at once. You must construct an input file in which each line +contains two values: the input coordinate pairs (either Equatorial +or Ecliptic). Then specify which coordinates you are using as input, +and identify the input and output filenames. Finally, press the +<guibutton>Run</guibutton> button to generate the output file, +which will contain the converted coordinates (Equatorial or +Ecliptic; the complement of what you chose as the input values). +</para> +</sect2> diff --git a/doc/kstars/calc-ecliptic.png b/doc/kstars/calc-ecliptic.png Binary files differnew file mode 100644 index 00000000..7d048999 --- /dev/null +++ b/doc/kstars/calc-ecliptic.png diff --git a/doc/kstars/calc-eqgal.docbook b/doc/kstars/calc-eqgal.docbook new file mode 100644 index 00000000..29f04021 --- /dev/null +++ b/doc/kstars/calc-eqgal.docbook @@ -0,0 +1,34 @@ +<sect2 id="calc-eqgal"> +<title>Equatorial/Galactic Coordinates module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Equatorial/Galactic Coordinates module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Equatorial/Galactic Coordinates calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-eqgal.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Equatorial/Galactic Coordinates</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This module converts from <link linkend="equatorial">Equatorial +coordinates</link> to <link linkend="galactic">Galactic +coordinates</link>, and vice versa. First, select which coordinates +should be taken as input values in the <guilabel>Input +Selection</guilabel> section. Then, fill in the corresponding +coordinate values in either the <guilabel>Galactic +coordinates</guilabel> or <guilabel>Equatorial coordinates</guilabel> +section. Finally, press the <guibutton>Compute</guibutton> button, +and the complementary coordinates will be filled in. +</para> +</sect2> + diff --git a/doc/kstars/calc-eqgal.png b/doc/kstars/calc-eqgal.png Binary files differnew file mode 100644 index 00000000..811f6418 --- /dev/null +++ b/doc/kstars/calc-eqgal.png diff --git a/doc/kstars/calc-equinox.docbook b/doc/kstars/calc-equinox.docbook new file mode 100644 index 00000000..b43d4190 --- /dev/null +++ b/doc/kstars/calc-equinox.docbook @@ -0,0 +1,42 @@ +<sect2 id="calc-equinox"> +<title>Equinoxes and Solstices module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Equinoxes and Solstices module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Equinoxes and Solstices calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-equinox.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Equinoxes and Solstices</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The <link linkend="ai-equinox">Equinoxes</link> and +Solstices module calculates the date and time of an +equinox or solstice for a given year. You specify which +event (Spring Equinox, Summer Solstice, Autumn Equinox, +or Winter Solstice) should be investigated, and the year. +Then press the <guibutton>Compute</guibutton> button to +obtain the date and time of the event, and the length of +the corresponding season, in days. +</para> +<para> +There is a batch mode for this module. To use it, simply +generate an input file whose lines each contain a year +for which the Equinox and Solstice data will be computed. +Then specify the input and output filenames, and press the +<guibutton>Run</guibutton> button to generate the output +file. Each line in the output file contains the input year, +the date and time of each event, and the length of each +season. +</para> +</sect2> diff --git a/doc/kstars/calc-equinox.png b/doc/kstars/calc-equinox.png Binary files differnew file mode 100644 index 00000000..182cfc10 --- /dev/null +++ b/doc/kstars/calc-equinox.png diff --git a/doc/kstars/calc-geodetic.docbook b/doc/kstars/calc-geodetic.docbook new file mode 100644 index 00000000..b8b9655f --- /dev/null +++ b/doc/kstars/calc-geodetic.docbook @@ -0,0 +1,43 @@ +<sect2 id="calc-geodetic"> +<title>Geodetic Coordinates module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Geodetic Coordinates module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Geodetic Coordinates calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-geodetic.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Geodetic Coordinates</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The normal <link linkend="ai-geocoords">geographic coordinate +system</link> assumes that the Earth is a perfect sphere. This is +nearly true, so for most purposes geographic coordinates are fine. +If very high precision is required, then we must take the true shape +of the Earth into account. The Earth is an ellipsoid; the distance +around the equator is about 0.3% longer than a <link +linkend="ai-greatcircle">Great Circle</link> that passes through the +poles. The <firstterm>Geodetic Coordinate system</firstterm> takes +this ellipsoidal shape into account, and expresses the position +on the Earth's surface in Cartesian coordinates (X, Y, and Z). +</para> +<para> +To use the module, first select which coordinates you will use as +input in the <guilabel>Input Selection</guilabel> section. Then, fill +in the input coordinates in either the <guilabel>Cartesian +Coordinates</guilabel> section or the <guilabel>Geographic +Coordinates</guilabel> section. When you press the +<guibutton>Compute</guibutton> button, the corresponding +coordinates will be filled in. +</para> +</sect2> diff --git a/doc/kstars/calc-geodetic.png b/doc/kstars/calc-geodetic.png Binary files differnew file mode 100644 index 00000000..8cd080a6 --- /dev/null +++ b/doc/kstars/calc-geodetic.png diff --git a/doc/kstars/calc-horizontal.docbook b/doc/kstars/calc-horizontal.docbook new file mode 100644 index 00000000..b4cdcd21 --- /dev/null +++ b/doc/kstars/calc-horizontal.docbook @@ -0,0 +1,35 @@ +<sect2 id="calc-horiz"> +<title>Horizontal Coordinates module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Horizontal Coordinates module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Horizontal Coordinates calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-horizontal.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Horizontal Coordinates</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This module converts from <link linkend="equatorial">Equatorial +coordinates</link> to <link linkend="horizontal">Horizontal +coordinates</link>. First, select the date, time, and +geographic coordinates for the calculation in the +<guilabel>Input Data</guilabel> section. Then, fill in the +equatorial coordinates to be converted and their catalog epoch +in the <guilabel>Equatorial Coordinates</guilabel> section. +When you press the <guibutton>Compute</guibutton> button, +the corresponding Horizontal coordinates will be presented in +the <guilabel>Horizontal Coordinates</guilabel> section. +</para> +</sect2> + diff --git a/doc/kstars/calc-horizontal.png b/doc/kstars/calc-horizontal.png Binary files differnew file mode 100644 index 00000000..169c781f --- /dev/null +++ b/doc/kstars/calc-horizontal.png diff --git a/doc/kstars/calc-julian.png b/doc/kstars/calc-julian.png Binary files differnew file mode 100644 index 00000000..5cd43cf8 --- /dev/null +++ b/doc/kstars/calc-julian.png diff --git a/doc/kstars/calc-julianday.docbook b/doc/kstars/calc-julianday.docbook new file mode 100644 index 00000000..4c01d698 --- /dev/null +++ b/doc/kstars/calc-julianday.docbook @@ -0,0 +1,41 @@ +<sect2 id="calc-julian"> +<title>Julian Day module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Julian Day module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Julian Day calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-julian.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Julian Day</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This module converts between the calendar date, the <link +linkend="ai-julianday">Julian Day</link>, and the +<firstterm>Modified Julian Day</firstterm>. The Modified Julian Day +is simply equal to the Julian Day - 2,400,000.5. +</para><para> +To use the module, select which of the three dates will be the input, +and then fill in its value. Then press the +<guibutton>Compute</guibutton> button, and the corresponding values for +the other two date systems will be displayed. +</para> + +<tip> +<para>Exercise:</para> +<para> +What calendar date does MJD = 0.0 correspond to? +</para> +</tip> + +</sect2> 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> diff --git a/doc/kstars/calc-planetcoords.png b/doc/kstars/calc-planetcoords.png Binary files differnew file mode 100644 index 00000000..23351e10 --- /dev/null +++ b/doc/kstars/calc-planetcoords.png diff --git a/doc/kstars/calc-precess.docbook b/doc/kstars/calc-precess.docbook new file mode 100644 index 00000000..2888b22d --- /dev/null +++ b/doc/kstars/calc-precess.docbook @@ -0,0 +1,37 @@ +<sect2 id="calc-precess"> +<title>Precession module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Precession module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Precession calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-precess.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Precession</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This module is similar to the <link linkend="calc-apcoords">Apparent +Coordinates module</link>, but it only applies the effect of +<link linkend="ai-precession">precession</link>, not of nutation or +aberration. +</para> +<para> +To use the module, first enter the input coordinates and their epoch +in the <guilabel>Original Coordinates</guilabel> section. You must +also fill in the target epoch in the <guilabel>Precessed +Coordinates</guilabel> section. Then, press the +<guibutton>Compute</guibutton> button, and the object's +coordinates, precessed to the target Epoch, are presented in the +<guilabel>Precessed Coordinates</guilabel> section. +</para> +</sect2> diff --git a/doc/kstars/calc-precess.png b/doc/kstars/calc-precess.png Binary files differnew file mode 100644 index 00000000..0ce11ead --- /dev/null +++ b/doc/kstars/calc-precess.png diff --git a/doc/kstars/calc-sidereal.docbook b/doc/kstars/calc-sidereal.docbook new file mode 100644 index 00000000..8f05e340 --- /dev/null +++ b/doc/kstars/calc-sidereal.docbook @@ -0,0 +1,32 @@ +<sect2 id="calc-sidereal"> +<title>Sidereal Time module</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +<tertiary>Sidereal Time module</tertiary> +</indexterm> + +<screenshot> +<screeninfo> +The Sidereal Time calculator module +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="calc-sidereal.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Sidereal Time</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This module converts between <link linkend="ai-utime">Universal +Time</link> and Local <link linkend="ai-sidereal">Sidereal Time</link>. +First, select whether you will use Universal Time or Sidereal Time +as an input value in the <guilabel>Input Selection</guilabel> section. +You must also specify a geographic longitude, and a date for the +calculation, in addition to either the Universal Time or the Sidereal +Time value. When you press the <guibutton>Compute</guibutton> button, +the corresponding value for the other Time will be displayed. +</para> +</sect2> diff --git a/doc/kstars/calc-sidereal.png b/doc/kstars/calc-sidereal.png Binary files differnew file mode 100644 index 00000000..0acb0409 --- /dev/null +++ b/doc/kstars/calc-sidereal.png diff --git a/doc/kstars/calculator.docbook b/doc/kstars/calculator.docbook new file mode 100644 index 00000000..9b40800c --- /dev/null +++ b/doc/kstars/calculator.docbook @@ -0,0 +1,48 @@ +<sect1 id="tool-calculator"> +<title>The Astrocalculator</title> +<indexterm><primary>Tools</primary> +<secondary>Astrocalculator</secondary> +</indexterm> + +<para> +The &kstars; Astrocalculator provides several modules that +give you direct access to algorithms used by the program. +The modules are organized by subject: + +<itemizedlist><title>Coordinate Converters</title> +<listitem><para><link linkend="calc-angdist">Angular Distance</link></para></listitem> +<listitem><para><link linkend="calc-apcoords">Apparent Coordinates</link></para></listitem> +<listitem><para><link linkend="calc-ecliptic">Ecliptic Coordinates</link></para></listitem> +<listitem><para><link linkend="calc-eqgal">Equatorial/Galactic Coordinates</link></para></listitem> +<listitem><para><link linkend="calc-horiz">Horizontal Coordinates</link></para></listitem> +<listitem><para><link linkend="calc-precess">Precession</link></para></listitem> +</itemizedlist> +<itemizedlist><title>Earth Coordinates</title> +<listitem><para><link linkend="calc-geodetic">Geodetic Coordinates</link></para></listitem> +</itemizedlist> +<itemizedlist><title>Solar System</title> +<listitem><para><link linkend="calc-planetcoords">Planets Coordinates</link></para></listitem> +</itemizedlist> +<itemizedlist><title>Time Calculators</title> +<listitem><para><link linkend="calc-dayduration">Day Duration</link></para></listitem> +<listitem><para><link linkend="calc-equinox">Equinoxes and Solstices</link></para></listitem> +<listitem><para><link linkend="calc-julian">Julian Day</link></para></listitem> +<listitem><para><link linkend="calc-sidereal">Sidereal Time</link></para></listitem> +</itemizedlist> +</para> + +&calc-angdist; +&calc-apcoords; +&calc-ecliptic; +&calc-eqgal; +&calc-horiz; +&calc-precess; +&calc-geodetic; +&calc-planetcoords; +&calc-dayduration; +&calc-equinox; +&calc-julian; +&calc-sidereal; + +</sect1> + diff --git a/doc/kstars/cequator.docbook b/doc/kstars/cequator.docbook new file mode 100644 index 00000000..31e730c5 --- /dev/null +++ b/doc/kstars/cequator.docbook @@ -0,0 +1,27 @@ +<sect1 id="ai-cequator"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>The Celestial Equator</title> +<indexterm><primary>Celestial Equator</primary> +<seealso>Equatorial Coordinates</seealso> +</indexterm> +<para> +The <firstterm>Celestial Equator</firstterm> is an imaginary <link +linkend="ai-greatcircle">great circle</link> on the <link +linkend="ai-csphere">celestial sphere</link>. The celestial equator +is the fundamental plane of the <link linkend="equatorial">Equatorial +Coordinate System</link>, so it is defined as the locus of points +with Declination of zero degrees. It is also the projection of the +Earth's equator onto the sky. +</para> +<para> +The Celestial Equator and the <link linkend="ai-ecliptic">Ecliptic</link> +are set at an angle of 23.5 degrees in the sky. The points where they +intersect are the Vernal and Autumnal <link +linkend="ai-equinox">Equinoxes</link>. +</para> +</sect1> diff --git a/doc/kstars/color_indices.png b/doc/kstars/color_indices.png Binary files differnew file mode 100644 index 00000000..ae684c57 --- /dev/null +++ b/doc/kstars/color_indices.png diff --git a/doc/kstars/colorandtemp.docbook b/doc/kstars/colorandtemp.docbook new file mode 100644 index 00000000..d0a762e6 --- /dev/null +++ b/doc/kstars/colorandtemp.docbook @@ -0,0 +1,174 @@ +<sect1 id="ai-colorandtemp"> + +<sect1info> + +<author> +<firstname>Jasem</firstname> +<surname>Mutlaq</surname> +<affiliation><address> +</address></affiliation> +</author> +</sect1info> + +<title>Star Colors and Temperatures</title> +<indexterm><primary>Star Colors and Temperatures</primary> +<seealso>Blackbody Radiation</seealso> +<seealso>Magnitude Scale</seealso> +</indexterm> + +<para> +Stars appear to be exclusively white at first glance. +But if we look carefully, we can notice a range of colors: blue, +white, red, and even gold. In the winter constellation of Orion, a +beautiful contrast is seen between the red Betelgeuse at Orion's +"armpit" and the blue Bellatrix at the shoulder. What causes stars to +exhibit different colors remained a mystery until two centuries ago, +when Physicists gained enough understanding of the nature of light and +the properties of matter at immensely high temperatures. +</para> + +<para> +Specifically, it was the physics of +<link linkend="ai-blackbody">blackbody radiation</link> that enabled +us to understand the variation of stellar colors. Shortly after +blackbody radiation was understood, it was noticed that the spectra of +stars look extremely similar to blackbody radiation curves of +various temperatures, ranging from a few thousand Kelvin to ~50,000 +Kelvin. The obvious conclusion is that stars are similar to +blackbodies, and that the color variation of stars is a direct +consequence of their surface temperatures. +</para> + +<para> +Cool stars (i.e., Spectral Type K and M) radiate most +of their energy in the red and infrared region of the +electromagnetic spectrum and thus appear red, while hot stars (i.e., +Spectral Type O and B) emit mostly at blue and ultra-violet +wavelengths, making them appear blue or white. +</para> + +<para> +To estimate the surface temperature of a star, we can use the known +relationship between the temperature of a blackbody, and the +wavelength of light where its spectrum peaks. That is, as you +increase the temperature of a blackbody, the peak of its spectrum +moves to shorter (bluer) wavelengths of light. +This is illustrated in Figure 1 where the intensity of three +hypothetical stars is plotted against wavelength. The "rainbow" +indicates the range of wavelengths that are visible to the human eye. +</para> + +<para> +<mediaobject> +<imageobject> + <imagedata fileref="star_colors.png" format="PNG"/> +</imageobject> +<caption><para><phrase>Figure 1</phrase></para></caption> +</mediaobject> +</para> + +<para> +This simple method is conceptually correct, but it cannot be used to +obtain stellar temperatures accurately, because stars are +<emphasis>not</emphasis> perfect blackbodies. The presence of various +elements in the star's atmosphere will cause certain wavelengths of +light to be absorbed. Because these absorption lines are not uniformly +distributed over the spectrum, they can skew the position of +the spectral peak. +Moreover, obtaining a usable spectrum of a star +is a time-intensive process and is prohibitively inefficient for large +samples of stars. +</para> + +<para> +An alternative method utilizes photometry to measure the intensity of +light +passing through different filters. Each filter allows +<emphasis>only</emphasis> a specific part of the spectrum +of light to pass through while rejecting all others. A widely used +photometric system is called the <firstterm>Johnson UBV +system</firstterm>. It employs three bandpass filters: U +("Ultra-violet"), B ("Blue"), and V ("Visible"); each occupying different regions of the +electromagnetic spectrum. +</para> + +<para> +The process of UBV photometry involves using light sensitive devices +(such as film or CCD cameras) and aiming a telescope at a star to +measure the intensity of light that passes through each of the +filters individually. This procedure gives three apparent +brightnesses or <link linkend="ai-flux">fluxes</link> (amount of +energy per cm^2 per second) designated by Fu, Fb, and Fv. The ratio of +fluxes Fu/Fb and Fb/Fv is a quantitative measure of the star's +"color", and these ratios can be used to establish a temperature scale +for stars. Generally speaking, the larger the Fu/Fb and Fb/Fv ratios +of a star, the hotter its surface temperature. +</para> + +<para> +For example, the star Bellatrix in Orion has Fb/Fv = 1.22, indicating +that it is brighter through the B filter than through the V filter. +furthermore, its Fu/Fb ratio is 2.22, so it is brightest through the U +filter. This indicates that the star must be very hot indeed, since +the position of its spectral peak must be somewhere in the range of +the U filter, or at an even shorter wavelength. The surface +temperature of Bellatrix (as determined from comparing its spectrum to +detailed models that account for its absorption lines) is about 25,000 +Kelvin. +</para> + +<para> +We can repeat this analysis for the star Betelgeuse. Its Fb/Fv and +Fu/Fb ratios are 0.15 and 0.18, respectively, so it is brightest +in V and dimmest in U. So, the spectral peak of Betelgeuse must be +somewhere in the range of the V filter, or at an even longer +wavelength. The surface temperature of Betelgeuse is only 2,400 +Kelvin. +</para> + +<para> +Astronomers prefer to express star colors in terms of a difference in +<link linkend="ai-magnitude">magnitudes</link>, rather than a ratio of +<link linkend="ai-flux">fluxes</link>. Therefore, going back to blue +Bellatrix we have a color index equal to +</para> + +<para> + B - V = -2.5 log (Fb/Fv) = -2.5 log (1.22) = -0.22, +</para> + +<para> +Similarly, the color index for red Betelgeuse is +</para> + +<para> + B - V = -2.5 log (Fb/Fv) = -2.5 log (0.18) = 1.85 +</para> + +<para> +The color indices, like the <link linkend="ai-magnitude">magnitude +scale</link>, run backward. <emphasis>Hot and blue</emphasis> +stars have <emphasis>smaller and negative</emphasis> values of B-V +than the cooler and redder stars. +</para> + +<para> +An Astronomer can then use the color indices for a star, after +correcting for reddening and interstellar extinction, to obtain an accurate temperature of that star. +The relationship between B-V and temperature is illustrated in Figure +2. +</para> + +<para> +<mediaobject> +<imageobject> + <imagedata fileref="color_indices.png" /> +</imageobject> +<caption><para><phrase>Figure 2</phrase></para></caption> +</mediaobject> +</para> + +<para> +The Sun with surface temperature of 5,800 K has a B-V index of 0.62. +</para> +</sect1> diff --git a/doc/kstars/commands.docbook b/doc/kstars/commands.docbook new file mode 100644 index 00000000..0efacac9 --- /dev/null +++ b/doc/kstars/commands.docbook @@ -0,0 +1,1192 @@ +<chapter id="commands"> +<title>Command Reference</title> + +<sect1 id="kstars-menus"> +<title>Menu Commands</title> +<indexterm><primary>Commands</primary><secondary>Menu</secondary></indexterm> + +<sect2 id="filemenu"> +<title><guimenu>File</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>New Window</guimenuitem> +</menuchoice></term> +<listitem><para>Open another &kstars; window +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Close Window</guimenuitem> +</menuchoice></term> +<listitem><para>Close &kstars; window +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Download Data...</guimenuitem> +</menuchoice></term> +<listitem><para>Open the <guilabel>Download Extra Data</guilabel> tool +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Open FITS...</guimenuitem> +</menuchoice></term> +<listitem><para>Open a FITS image in the FITS Editor tool +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save Sky Image...</guimenuitem> +</menuchoice></term> +<listitem><para>Create image on disk from current display +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Run Script...</guimenuitem> +</menuchoice></term> +<listitem><para>Run the specified KStars script +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Print...</guimenuitem> +</menuchoice></term> +<listitem><para>Send the current sky map to the printer (or to a +PostScript/PDF file) +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice></term> +<listitem><para>Quit &kstars; +</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="timemenu"> +<title><guimenu>Time</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo> +</shortcut> +<guimenu>Time</guimenu> +<guimenuitem>Set Time to Now</guimenuitem> +</menuchoice></term> +<listitem><para>Sync time to system clock</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Time</guimenu> +<guimenuitem>Set Time...</guimenuitem> +</menuchoice></term> +<listitem><para>Set time and date</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Time</guimenu> +<guimenuitem>Start/Stop Clock</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle whether time passes</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="pointmenu"> +<title><guimenu>Pointing</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>Z</keycap> +</shortcut> +<guimenu>Pointing</guimenu> +<guimenuitem>Zenith</guimenuitem> +</menuchoice></term> +<listitem><para>Center the display at the +<link linkend="ai-zenith">Zenith</link> point (straight up) +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>N</keycap> +</shortcut> +<guimenu>Pointing</guimenu> +<guimenuitem>North</guimenuitem> +</menuchoice></term> +<listitem><para>Center the display above the North point on the +horizon</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>E</keycap> +</shortcut> +<guimenu>Pointing</guimenu> +<guimenuitem>East</guimenuitem> +</menuchoice></term> +<listitem><para>Center the display above the East point on the +horizon</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>S</keycap> +</shortcut> +<guimenu>Pointing</guimenu> +<guimenuitem>South</guimenuitem> +</menuchoice></term> +<listitem><para>Center the display above the South point on the +horizon</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>W</keycap> +</shortcut> +<guimenu>Pointing</guimenu> +<guimenuitem>West</guimenuitem> +</menuchoice></term> +<listitem><para>Center the display above the West point on the +horizon</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> +</shortcut> +<guimenu>Pointing</guimenu> +<guimenuitem>Set Focus Manually...</guimenuitem> +</menuchoice></term> +<listitem><para>Center the display on specific +<link linkend="ai-skycoords">sky coordinates</link> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>Pointing</guimenu> +<guimenuitem>Find Object</guimenuitem> +</menuchoice></term> +<listitem><para>Locate an object by name using the +<link linkend="findobjects">Find Object Window</link></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo> +</shortcut> +<guimenu>Pointing</guimenu> +<guimenuitem>Engage/Stop Tracking</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle tracking on/off. While tracking, +the display will remain centered on the current position or +object.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="viewmenu"> +<title><guimenu>View</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>+</keycap> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Zoom in</guimenuitem> +</menuchoice></term> +<listitem><para>Zooms view in</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>-</keycap> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Zoom out</guimenuitem> +</menuchoice></term> +<listitem><para>Zooms view out</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Default Zoom</guimenuitem> +</menuchoice></term> +<listitem><para>Restore the default Zoom setting</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Zoom to Angular Size...</guimenuitem> +</menuchoice></term> +<listitem><para>Zoom to specified field-of-view angle</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Full Screen Mode</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle full-screen mode</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>Space</keycap> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Horizontal/Equatorial Coordinates</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle between the +<link linkend="horizontal">Horizontal</link> and +<link linkend="equatorial">Equatorial</link> +<link linkend="ai-skycoords">Coordinate Systems</link></para></listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="devicemenu"> +<title><guimenu>Devices</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Devices</guimenu> +<guimenuitem>Telescope Wizard...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the <guilabel>Telescope Wizard</guilabel>, which +provides a step-by-step guide to help you connect to your telescope and +control it with &kstars;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Devices</guimenu> +<guimenuitem>Device Manager</guimenuitem> +</menuchoice></term> +<listitem><para>Opens up the device manager, which allows you to start/shutdown device drivers and connect to remote INDI servers.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Devices</guimenu> +<guimenuitem>INDI Control Panel</guimenuitem> +</menuchoice></term> +<listitem><para>Opens up INDI Control Panel, which allows you to control all the features supported by a device.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Devices</guimenu> +<guimenuitem>Capture Image Sequence...</guimenuitem> +</menuchoice></term> +<listitem><para>Acquire images from a CCD camera or webcam device</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Devices</guimenu> +<guimenuitem>Configure INDI</guimenuitem> +</menuchoice></term> +<listitem><para>Opens up a dialog to configure INDI-related features such as automatic device updates.</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="toolmenu"> +<title><guimenu>Tools</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Calculator...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Opens the <link linkend="tool-calculator">AstroCalculator</link> Tool, +which provides full access to many of the mathematical functions used by +&kstars;. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Observing List...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Opens the <link linkend="tool-observinglist">Observing List</link> +Tool, which provide convenient access to some common functions for a list of +objects chosen by you.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>AAVSO Light Curves...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Opens the <link linkend="tool-aavso">AAVSO Light Curve Generator</link> +Tool, which allows you to download a light curve for any variable +star from the American Association of Variable Star Observers. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Altitude vs. Time...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Opens the <link linkend="tool-altvstime">Altitude vs. Time</link> Tool, which +can plot curves representing the altitude of any object as a +function of time. This is useful for planning observing +sessions. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>What's Up Tonight...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Opens the <link linkend="tool-whatsup">What's Up Tonight</link> Tool, +which presents a summary of the objects which are observable +from your location on a given date. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Script Builder...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Opens the <link linkend="tool-scriptbuilder">Script Builder</link> Tool, +which provides a GUI interface for building &kstars; DCOP scripts. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Solar System...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Opens the <link linkend="tool-solarsys">Solar System Viewer</link>, +which displays an overhead view of the solar system on the +current simulation date. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo> +</shortcut> +<guimenu>Tools</guimenu> +<guimenuitem>Jupiter's Moons...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Opens the <link linkend="tool-jmoons">Jupiter Moons Tool</link>, +which displays the positions of Jupiter's four brightest +moons as a function of time. +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="settingmenu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Info Boxes</guisubmenu> +<guimenuitem>Hide/Show Info Boxes</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle display of all three Info Boxes +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Info Boxes</guisubmenu> +<guimenuitem>Hide/Show Time</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle display of the Time Info Box +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Info Boxes</guisubmenu> +<guimenuitem>Hide/Show Focus</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle display of the Focus Info Box +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Info Boxes</guisubmenu> +<guimenuitem>Hide/Show Location</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle display of the Location Info Box +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Toolbars</guisubmenu> +<guimenuitem>Hide/Show Main Toolbar</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle display of the Main Toolbar +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Toolbars</guisubmenu> +<guimenuitem>Hide/Show View Toolbar</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle display of the View Toolbar +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Statusbar</guisubmenu> +<guimenuitem>Hide/Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle display of the Statusbar +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Statusbar</guisubmenu> +<guimenuitem>Hide/Show Az/Alt field</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle display of the mouse cursor's horizontal +coordinates in the statusbar +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Statusbar</guisubmenu> +<guimenuitem>Hide/Show RA/Dec field</guimenuitem> +</menuchoice></term> +<listitem><para>Toggle display of the mouse cursor's horizontal +coordinates in the statusbar +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Color Schemes</guisubmenu> +</menuchoice></term> +<listitem><para> +This submenu contains all of the defined color schemes, including your +custom schemes. Select any item to set that color scheme. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>FOV Symbols</guisubmenu> +</menuchoice></term> +<listitem><para> +This submenu lists the available field-of-view (FOV) Symbols. +The FOV Symbol is drawn at the center of the display. You +may choose from the list of predefined symbols (No symbol, +7x35 Binoculars, One degree, HST WFPC2 or 30m at 1.3cm), or you may define +your own symbols (or modify existing symbols) using the +<guimenuitem>Edit FOV symbols...</guimenuitem> item. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo> +</shortcut> +<guimenu>Settings</guimenu> +<guimenuitem>Geographic...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Select a new <link linkend="setgeo">geographic +location</link> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kstars;...</guimenuitem> +</menuchoice></term> +<listitem><para>Modify <link linkend="config">configuration +options</link></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Startup Wizard...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens the <link linkend="startwizard">Setup Wizard</link>, +which allows you to easily set your geographic location and download some +extra data files.</para></listitem> +</varlistentry> + + +</variablelist> +</sect2> + +<sect2 id="helpmenu"> +<title><guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect2> + +<sect2 id="popup-menu"> +<title>Popup Menu</title> +<indexterm><primary>Popup Menu</primary><secondary>Description</secondary></indexterm> + +<para> +The <mousebutton>right</mousebutton> click popup menu is +context-sensitive, meaning its content varies depending on what kind of +object you click on. We list all possible popup menu items here, with +the relevant object type [in brackets].</para> + +<variablelist> +<varlistentry> +<term>[All]</term> +<listitem><para> +Identification and type: The top one to three lines are devoted to the +name(s) of the object, and its type. For stars, the Spectral Type +is also shown here. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>[All]</term> +<listitem><para> +Rise, Transit, and Set times for the object on the current simulation +date are shown on the next three lines. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>[All]</term> +<listitem><para> +<guimenuitem>Center and Track</guimenuitem>: Center the display +on this location, and engage tracking. Equivalent to double-clicking. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>[All]</term> +<listitem><para> +<guimenuitem>Angular Distance To...</guimenuitem>: In this mode, +a dotted line is drawn from the first target object +to the current mouse position. When you invoke the popup menu of a second +object, this item will read <guilabel>Compute Angular Distance</guilabel>. +Selecting this item will display the angular distance between the two +objects in the statusbar. You can press the <keycap>Esc</keycap> key to +exit angular distance mode without measuring an angle. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>[All]</term> +<listitem><para> +<guimenuitem>Details</guimenuitem>: Open the +<link linkend="tool-details">Object Details window</link> for this object. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>[All]</term> +<listitem><para> +<guimenuitem>Attach Label</guimenuitem>: Attach a permanent name label +to the object. If the object already has a label attached, this item +will read <guilabel>Remove Label</guilabel>. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>[All]</term> +<listitem><para> +<guimenuitem>Show ... Image</guimenuitem>: download an image of the +object from the internet, and display it in the Image Viewer tool. +The "..." text is replaced by a short description of the image's +source. An object may have multiple image links available in its +popup menu. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>[All]</term> +<listitem><para> +<guimenuitem>... Page</guimenuitem>: Display a webpage about the object +in your default web browser. The "..." text is replaced by a short +description of the page. An object may have multiple web links available +in its popup menu. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>[All Named Objects]</term> +<listitem><para> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Internet Links</secondary> +<tertiary>Customizing</tertiary></indexterm> +<guimenuitem>Add Link...</guimenuitem>: This allows you to add your own +custom links to the popup menu of any object. It opens a small window +in which you enter the &URL; of the link, and the text you want to +appear in the popup menu. There is also a pair of radio buttons which +allow you to specify whether the &URL; is an image or an +<acronym>HTML</acronym> document, so &kstars; knows whether to launch +the web browser or the image viewer. You can use this to add links to +files on your local disk, so this feature could be used to attach +observing logs or other custom information to objects in &kstars;. +Your custom links are automatically loaded whenever &kstars; starts up, +and they are stored in the folder <filename +class="directory">~/.kde/share/apps/kstars/</filename>, in files +<filename>myimage_url.dat</filename> and +<filename>myinfo_url.dat</filename>. If you build an extensive list +of custom links, consider submitting them to us, we would like to +include them in the next version of &kstars;! +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> +</sect1> + +<sect1 id="kstars-keys"> +<title>Keyboard Commands</title> +<indexterm><primary>Commands</primary> +<secondary>Keyboard</secondary></indexterm> + +<sect2 id="nav-keys"> +<title>Navigation Keys</title> +<indexterm><primary>Navigation Controls</primary> +<secondary>Keyboard</secondary></indexterm> + +<variablelist> +<varlistentry><term>Arrow Keys</term> +<listitem><para> +Use the arrow keys to pan the display. Holding down the &Shift; +key doubles the scrolling speed. +</para></listitem></varlistentry> + +<varlistentry> +<term><keycap>+</keycap> / <keycap>-</keycap></term> +<listitem><para>Zoom In/Out</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></term> +<listitem><para>Restore the default Zoom setting</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></term> +<listitem><para>Zoom to specified field-of-view angle</para></listitem> +</varlistentry> + +<varlistentry> +<term>0–9</term> +<listitem><para>Center Display on a major Solar System body: +<itemizedlist> +<listitem><para>0: Sun</para></listitem> +<listitem><para>1: Mercury</para></listitem> +<listitem><para>2: Venus</para></listitem> +<listitem><para>3: Moon</para></listitem> +<listitem><para>4: Mars</para></listitem> +<listitem><para>5: Jupiter</para></listitem> +<listitem><para>6: Saturn</para></listitem> +<listitem><para>7: Uranus</para></listitem> +<listitem><para>8: Neptune</para></listitem> +<listitem><para>9: Pluto</para></listitem> +</itemizedlist> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap>Z</keycap></term> +<listitem><para>Center the display at the <link linkend="ai-zenith">Zenith</link> +Point (straight up)</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap>N</keycap></term> +<listitem><para>Center the display above the North point on the horizon</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap>E</keycap></term> +<listitem><para>Center the display above the East point on the horizon</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap>S</keycap></term> +<listitem><para>Center the display above the South point on the horizon</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycap>W</keycap></term> +<listitem><para>Center the display above the West point on the horizon</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo></term> +<listitem><para>Toggle tracking mode</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap><</keycap></term> +<listitem><para>Advance the simulation clock backwards by one time step</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycap>></keycap></term> +<listitem><para>Advance the simulation clock forwards by one time step</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="menu-keys"> +<title>Menu Shortcuts</title> +<indexterm><primary>Commands</primary> +<secondary>Menu</secondary> +<tertiary>Keyboard Shortcuts</tertiary> +</indexterm> + +<variablelist> +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></term> +<listitem><para>Open a new &kstars; window</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo></term> +<listitem><para>Close a &kstars; window</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo></term> +<listitem><para>Download extra data</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></term> +<listitem><para>Open a FITS image in the FITS Editor</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo></term> +<listitem><para>Export sky image to a file</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></term> +<listitem><para>Run a &kstars; DCOP script</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></term> +<listitem><para>Print the current sky map</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></term> +<listitem><para>Quit &kstars;</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo></term> +<listitem><para>Sync the simulation clock with the current system time</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></term> +<listitem><para>Set the simulation clock to a specified Time and Date</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></term> +<listitem><para>Toggle full-screen mode</para></listitem> +</varlistentry> + +<varlistentry><term><keycap>Space</keycap></term> +<listitem><para>Toggle between the +<link linkend="horizontal">Horizontal</link> and +<link linkend="equatorial">Equatorial</link> +<link linkend="ai-skycoords">Coordinate Systems</link> +</para></listitem></varlistentry> + +<varlistentry> +<term><keycap>F1</keycap></term> +<listitem><para>Open the &kstars; Handbook</para></listitem> +</varlistentry> +</variablelist> +</sect2> + + +<sect2 id="object-actions"> +<title>Actions for the Selected Object</title> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Keyboard Actions</secondary></indexterm> + +<para>Each of the following keystrokes performs an action on the +<firstterm>selected object</firstterm>. The selected object is the last +object which was clicked on (identified in the status bar). Alternatively, +if you hold down the <keycap>Shift</keycap> key, then the action is +performed on the centered object instead.</para> + +<!-- FIXME: this feature does not exist yet; to be added after feature thaw +<variablelist> +<varlistentry> +<term><keycap>C</keycap></term> +<listitem><para>Center and Track on the selected object</para></listitem> +</varlistentry> +--> +<variablelist> +<varlistentry> +<term><keycap>D</keycap></term> +<listitem><para>Open the Details window for the selected object</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap>L</keycap></term> +<listitem><para>Toggle a name label for the selected object</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap>O</keycap></term> +<listitem><para>Add the selected object to the observing list</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap>P</keycap></term> +<listitem><para>Open the selected object's popup menu</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap>T</keycap></term> +<listitem><para>Toggle a trail on the selected object (solar system bodies only)</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="tools-keys"> +<title>Tools Shortcuts</title> + +<variablelist> +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></term> +<listitem><para>Open the <link linkend="findobjects">Find Object window</link>, +for specifying a sky object on which to center</para></listitem> +</varlistentry> + +<varlistentry><term><keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> +</term> +<listitem><para>Open the <guilabel>Set Focus Manually...</guilabel> tool, +for specifying RA/Dec or Az/Alt coordinates on which to center</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycap>[</keycap> / <keycap>]</keycap></term> +<listitem><para>Start/End an Angular Distance measurement at the current mouse +cursor position. The angular distance between start and end points is displayed +in the statusbar.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></term> +<listitem><para>Open the <link linkend="setgeo">Set Geographic Location</link> +window</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></term> +<listitem><para>Open the <link linkend="tool-calculator">AstroCalculator</link> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo></term> +<listitem><para>Open the <link linkend="tool-aavso">AAVSO Lightcurve Generator</link> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></term> +<listitem><para>Open the <link linkend="tool-altvstime">Altitude vs. Time</link> +tool</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo></term> +<listitem><para>Open the <link linkend="tool-whatsup">What's Up Tonight?</link> +tool</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo></term> +<listitem><para>Open the <link linkend="tool-scriptbuilder">Script Builder</link> +tool</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo></term> +<listitem><para>Open the <link linkend="tool-solarsys">Solar System Viewer</link> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo></term> +<listitem><para>Open the <link linkend="tool-jmoons">Jupiter Moons</link> +tool</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo></term> +<listitem><para>Open the <link linkend="tool-observinglist">Observing List</link> +tool</para></listitem> +</varlistentry> + +</variablelist> +</sect2> +</sect1> + +<sect1 id="kstars-mouse"> +<title>Mouse Commands</title> +<indexterm><primary>Commands</primary> +<secondary>Mouse</secondary></indexterm> +<indexterm><primary>Navigation Controls</primary> +<secondary>Mouse</secondary></indexterm> + +<variablelist> +<varlistentry><term>Moving the mouse</term> +<listitem><para> +The sky coordinates (RA/Dec and Az/Alt) of the mouse cursor are updated +in the status bar +</para></listitem> +</varlistentry> + +<varlistentry><term>"Hovering" the mouse</term> +<listitem><para> +A temporary name label is attached to the object nearest to the mouse cursor. +</para></listitem> +</varlistentry> + +<varlistentry><term>Left-clicking</term> +<listitem> +<para> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Identifying</secondary></indexterm> +The object nearest the mouse click is identified in the +status bar. +</para></listitem> +</varlistentry> + +<varlistentry><term>Double-clicking</term> +<listitem> +<para> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Centering</secondary></indexterm> +Center and track on the location or object +nearest the mouse click. Double-clicking on an Info Box will +<quote>shade</quote> it to show/hide extra information. +</para></listitem> +</varlistentry> + +<varlistentry><term>Right-clicking</term> +<listitem> +<para> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Invoking Popup Menu for</secondary></indexterm> +Open the <link linkend="popup-menu">popup menu</link> for the +location or object nearest the mouse cursor. +</para></listitem> +</varlistentry> + +<varlistentry><term>Scrolling the mouse wheel</term> +<listitem><para>Zoom the display in or out. If you do not +have a mouse wheel, you can hold the middle mouse button and +drag vertically. +</para></listitem> +</varlistentry> + +<varlistentry><term>Click-and-dragging</term> +<listitem><para> + <variablelist> + <varlistentry><term>Dragging the sky map</term> + <listitem><para>Pan the display, following the drag motion. + </para></listitem></varlistentry> + + <varlistentry><term>&Ctrl;+dragging the sky map</term> + <listitem><para>Define a rectangle in the map. When the + mouse button is released, the display is zoomed in to match the + field-of-view to the bounds of the rectangle. + </para></listitem></varlistentry> + + <varlistentry><term>Dragging an Info Box</term> + <listitem><para>The Info Box is repositioned in the map. Info + Boxes will <quote>stick</quote> to window edges, so that they + remain on the edge when the window is resized. + </para></listitem></varlistentry> + </variablelist> +</para></listitem> +</varlistentry> +</variablelist> + +</sect1> +</chapter> diff --git a/doc/kstars/config.docbook b/doc/kstars/config.docbook new file mode 100644 index 00000000..38389e65 --- /dev/null +++ b/doc/kstars/config.docbook @@ -0,0 +1,379 @@ +<chapter id="config"> +<title>Configuring &kstars;</title> + +<sect1 id="setgeo"> +<title>Setting the Geographic Location</title> + +<para> +Here is a screenshot of the <guilabel>Set Geographic Location</guilabel> +window: +<screenshot> +<screeninfo>Changing the Geographic Location</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="geolocator.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Set Location Window</phrase> + </textobject> +</mediaobject> +</screenshot> +</para> + +<para> +There is a list of over 2500 predefined cities available to choose from. +You set your location by highlighting a city from this list. Each +city is represented in the world map as a small dot, and when a city +is highlighted in the list, a red crosshairs appears on its location +in the map. +</para> + +<para> +<indexterm><primary>Geographic Location Tool</primary> +<secondary>Filtering</secondary></indexterm> +It is not practical to scroll through the full list of 2500 locations, +looking for a specific city. To make searches easier, the list can be +filtered by entering text in the boxes below the map. For example, in +the screenshot, the text <quote>Ba</quote> appears in the +<guilabel>City Filter</guilabel> box, while <quote>M</quote> has been +entered in the <guilabel>Province Filter</guilabel> box, and +<quote>USA</quote> is in the <guilabel>Country Filter</guilabel> +box. Note that all of the cities displayed in the list have city, +province, and country names that begin with the entered filter +strings, and that the message below the filter boxes indicates that 7 +cities are matched by the filters. Also notice that the dots +representing these seven cities in the map have been colored white, +while the unmatched cities remain gray. +</para><para> +The list can also be filtered by location in the map. Clicking anywhere +in the world map will show only those cities within two degrees of the +clicked location. At this time, you can search by name, or by location, +but not both at once. In other words, when you click on the map, the +name filters are ignored, and vice versa. +</para><para> +<indexterm><primary>Geographic Location Tool</primary> +<secondary>Custom locations</secondary></indexterm> +The <link linkend="ai-geocoords">longitude, latitude</link> and +<link linkend="ai-timezones">time zone</link> information for the +currently-selected location are displayed in the boxes at the bottom of +the window. If you feel that any of these values are inaccurate, you +can modify them and press the <guibutton>Add to List</guibutton> button +to record your custom version of the location. You can also define a +completely new location by pressing the +<guibutton>Clear Fields</guibutton> button, and entering the data for +the new location. Note that all fields except the optional +<guilabel>State/Province</guilabel> must be filled before the new +location can be added to the list. &kstars; will automatically load +your custom locations for all future sessions. Please note, at this +point, the only way to remove a custom location is to remove the +appropriate line from the file +<filename>~/.kde/share/apps/kstars/mycities.dat</filename>. +</para><para> +If you add custom locations (or modify existing ones), please send us +your <filename>mycities.dat</filename> file so that we can add your +locations to the master list. +</para> +</sect1> + +<sect1 id="settime"> +<title>Setting the Time</title> +<para> +<indexterm><primary>Date and Time</primary> +<secondary>The simulation clock</secondary></indexterm> +When &kstars; starts up, the time is set to your computer's system +clock, and the &kstars; clock is running to keep up with the real time. +If you want to stop the clock, select <guimenuitem>Stop +Clock</guimenuitem> from the <guimenu>Time</guimenu> menu, or simply +click on the <guiicon>Pause</guiicon> icon in the toolbar. You can +make the clock run slower or faster than normal, or even make it run +backward, using the time-step spinbox in the toolbar. This spinbox +has two sets of up/down buttons. The first one will step through all +83 available time steps, one by one. The second one will skip to the +next higher (or lower) unit of time, which allows you to make large +timestep changes more quickly. +</para> +<para> +<indexterm><primary>Date and Time</primary> +<secondary>Setting</secondary></indexterm> +You can set the time and date by selecting <guimenuitem>Set +Time...</guimenuitem> from the <guimenu>Time</guimenu> menu, or by +pressing the <guiicon>time</guiicon> icon in the toolbar. The +<guilabel>Set Time</guilabel> window uses a standard &kde; Date Picker +widget, coupled with three spinboxes for setting the hours, minutes and +seconds. If you want to re-synchronize the simulation clock back to the +current CPU time, just select <guimenuitem>Set Time to Now</guimenuitem> +from the <guimenu>Time</guimenu> menu.</para> + +<note><para> +<indexterm><primary>Date and Time</primary> +<secondary>Extended range of dates</secondary></indexterm> +&kstars; can accept very remote dates beyond the usual limits imposed by +QDate. Currently, you can set the date between the years -50000 and +50000. +We may extend this range even further in future releases. However, please +be aware that the accuracy of the simulation becomes more and more degraded +as more remote dates are examined. This is especially true for the positions +of solar system bodies. +</para></note> +</sect1> + +<sect1 id="viewops"> +<title>The Configure &kstars; Window</title> +<para> +<indexterm><primary>Configure &kstars; window</primary></indexterm> +The <guilabel>Configure &kstars;</guilabel> window allows you to modify +a wide range of display options. You can access the window with the +<guiicon>configure</guiicon> toolbar icon, or by selecting +<guimenuitem>Configure &kstars;...</guimenuitem> from the +<guimenu>Settings</guimenu> menu. +The window is depicted below: + +<screenshot> +<screeninfo>Configure &kstars; Window</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="viewops.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Configure &kstars; Window</phrase> + </textobject> +</mediaobject> +</screenshot> +</para> + +<para> +The <guilabel>Configure &kstars;</guilabel> window is divided into five +tabs: +<guilabel>Catalogs</guilabel>, <guilabel>Guides</guilabel>, +<guilabel>Solar System</guilabel>, <guilabel>Colors</guilabel>, and +<guilabel>Advanced</guilabel>. +</para> +<para> +<indexterm><primary>Configure &kstars; window</primary> +<secondary>Catalogs Tab</secondary></indexterm> +In the <guilabel>Catalogs</guilabel> tab, you determine which object +catalogs are displayed in the map. The <guilabel>Stars</guilabel> section +also allows you to set the +<quote>faint <link linkend="ai-magnitude">magnitude</link> limit</quote> +for stars, and the <link linkend="ai-magnitude">magnitude</link> limit for +displaying the names and/or magnitudes of stars. Below the stars section, +the <guilabel>Deep-Sky Objects</guilabel> section controls the display of +several non-stellar object catalogs. By default, the list includes the +Messier, NGC and IC catalogs. You can add your own custom object catalogs +by pressing the <guibutton>Add Custom Catalog</guibutton> button. For +detailed instructions on preparing a catalog data file, see the +<filename>README.customize</filename> file that ships with &kstars;. +</para> +<para> +<indexterm><primary>Configure &kstars; window</primary> +<secondary>Solar System Tab</secondary></indexterm> +In the <guilabel>Solar System</guilabel> tab, you can specify whether +the Sun, Moon, planets, comets and asteroids are displayed, and +whether the major bodies are drawn as colored circles or actual images. +You can also toggle whether solar system bodies have name labels attached, +and control how many of the comets and asteroids get name labels. +There is an option to automatically attach a temporary <quote>orbit +trail</quote> whenever a solar system body is tracked, and another to +toggle whether the color of the orbit trail fades into the background +sky color. +</para> +<para> +<indexterm><primary>Configure &kstars; window</primary> +<secondary>Guides Tab</secondary></indexterm> +The <guilabel>Guides</guilabel> tab lets you toggle whether non-objects +are displayed (&ie;, constellation lines, constellation names, the +Milky Way contour, the <link linkend="ai-cequator">celestial +equator</link>, <link linkend="ai-ecliptic">the ecliptic</link>, <link +linkend="ai-horizon">the horizon line</link>, and the opaque ground). +You can also choose whether you would like to see Latin constellation +names, <acronym>IAU</acronym>-standard three-letter abbreviations, or +constellation names using your local language. +</para> +<para> +<indexterm><primary>Configure &kstars; window</primary> +<secondary>Colors Tab</secondary></indexterm> +<indexterm><primary>Color Schemes</primary> +<secondary>Customizing</secondary></indexterm> +The <guilabel>Colors</guilabel> tab allows you to set the color scheme, +and to define custom color schemes. The tab is split into two panels: +</para> +<para> +The left panel shows a list of all display items with adjustable +colors. Click on any item to bring up a color selection window to +adjust its color. Below the list is the <guilabel>Star Color +Mode</guilabel> selection box. By default, &kstars; draws stars with +a <link linkend="ai-colorandtemp">realistic color</link> tint according +to the spectral type of the star. However, you may also choose to draw +the stars as solid white, black or red circles. If you are using the +realistic star colors, you can set the saturation level of the star +colors with the <guilabel>Star Color Intensity</guilabel> spinbox. +</para> +<para> +The right panel lists the defined color schemes. There are four +predefined schemes: the <guilabel>Default</guilabel> scheme, +<guilabel>Star Chart</guilabel>, which uses black stars on a white +background, <guilabel>Night Vision</guilabel>, which uses only shades +of red in order to protect dark-adapted vision, and <guilabel>Moonless +Night</guilabel>, a more realistic, dark theme. Additionally, +you can save the current color settings as a custom scheme by clicking +the <guibutton>Save Current Colors</guibutton> button. It will prompt +you for a name for the new scheme, and then your scheme will appear in +the list in all future &kstars; sessions. To remove a custom scheme, +simply highlight it in the list, and press the <guibutton>Remove Color +Scheme</guibutton> button. +</para><para> +<indexterm><primary>Configure &kstars; window</primary> +<secondary>Advanced Tab</secondary></indexterm> +The <guilabel>Advanced</guilabel> Tab provides fine-grained control +over the more subtle behaviors of &kstars;. +</para><para> +<indexterm><primary>Atmospheric Refraction</primary></indexterm> +The <guilabel>Correct for atmospheric refraction</guilabel> checkbox +controls whether the positions of objects are corrected for the effects +of the atmosphere. Because the atmosphere is a spherical shell, light from +outer space is <quote>bent</quote> as it passes through the atmosphere to +our telescopes or eyes on the Earth's surface. The effect is largest for +objects near the horizon, and actually changes the predicted rise or set +times of objects by a few minutes. In fact, when you <quote>see</quote> a +sunset, the Sun's actual position is already well below the horizon; +atmospheric refraction makes it seem as if the Sun is still in the sky. +Note that atmospheric refraction is never applied if you are using +<guilabel>Equatorial coordinates</guilabel>. +</para><para> +<indexterm><primary>Animated Slewing</primary></indexterm> +The <guilabel>Use animating slewing</guilabel> checkbox controls how the +display changes when a new focus position is selected in the map. By +default, you will see the sky drift or <quote>slew</quote> to the new +position; if you uncheck this option, then the display will instead +<quote>snap</quote> immediately to the new focus position. +</para><para> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Labeling</secondary> +<tertiary>Automatic</tertiary> +</indexterm> +If the <guilabel>Attach label to centered object</guilabel> checkbox is +selected, then a name label will automatically be attached to an object +when it is being tracked by the program. The label will be removed when +the object is no longer being tracked. Note that you can also manually +attach a persistent name label to any object with its <link +linkend="popup-menu">popup menu</link>. +</para><para> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Hiding</secondary></indexterm> +There are three situations when &kstars; must redraw the sky display very +rapidly: when a new focus position is selected (and <guilabel>Use +animated slewing</guilabel> is checked), when the sky is dragged with the +mouse, and when the time step is large. In these situations, the positions +of all objects must be recomputed as rapidly as possible, which can put +a large load on the <abbrev>CPU</abbrev>. If the <abbrev>CPU</abbrev> +cannot keep up with the demand, then the display will seem sluggish or jerky. +To mitigate this, &kstars; will hide certain objects during these rapid-redraw +situations, as long as the <guilabel>Hide objects while moving</guilabel> +checkbox is selected. The timestep threshold above which objects will be +hidden is determined by the <guilabel>Also hide if timescale greater +than:</guilabel> timestep-spinbox. You can specify the objects that should +be hidden in the <guilabel>Configure Hidden Objects</guilabel> group box. +</para> +</sect1> + +<sect1 id="customize"> +<title>Customizing the Display</title> + +<para> +There are several ways to modify the display to your liking.</para> +<itemizedlist> +<listitem><para> +<indexterm><primary>Color Schemes</primary><secondary>Selecting</secondary></indexterm> +Select a different color scheme in the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Color Schemes</guimenuitem></menuchoice> +menu. There are four predefined color schemes, and you can define your own in the +<link linkend="config"><guilabel>Configure &kstars;</guilabel></link> window. +</para></listitem> +<listitem><para> +<indexterm><primary>Toolbars</primary> +<secondary>Customizing</secondary></indexterm> +Toggle whether the Toolbars are drawn in the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Toolbars</guimenuitem></menuchoice> +menu. Like most KDE toolbars, they can also be dragged around and +anchored on any window edge, or even detached from the window completely. +</para></listitem> +<listitem><para> +<indexterm><primary>Info Boxes</primary><secondary>Customizing</secondary></indexterm> +<indexterm><primary>Info Boxes</primary><secondary>Shading</secondary></indexterm> +Toggle whether the Info Boxes are drawn in the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Info Boxes</guimenuitem></menuchoice> +menu. In addition, you can manipulate the three Info Boxes with the +mouse. Each box has additional lines of data that are hidden by default. +You can toggle whether these additional lines are visible by double-clicking +a box to <quote>shade</quote> it. Also, you can reposition a box by +dragging it with the mouse. When a box hits a window edge, it will +<quote>stick</quote> to the edge when the window is resized. +</para></listitem> +<listitem> +<para> +<indexterm><primary>Field-of-View Symbols</primary><secondary>Description</secondary></indexterm> +Choose an <quote>FOV Symbol</quote> using the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>FOV Symbols</guimenuitem></menuchoice> +menu. <firstterm>FOV</firstterm> is an acronym for <quote>field-of-view</quote>. +An FOV symbol is drawn at the center of the window to indicate where the display +is pointing. Different symbols have different angular sizes; you can use a symbol to show +what the view through a particular telescope would look like. For example, if you choose +the <quote>7x35 Binoculars</quote> FOV symbol, then a circle is drawn on the display that is +9.2 degrees in diameter; this is the field-of-view for 7x35 binoculars. +</para> +<para> +<indexterm><primary>Field-of-View Symbols</primary><secondary>Customizing</secondary></indexterm> +You can define your own FOV symbols (or modify the existing symbols) using the +<guimenuitem>Edit FOV Symbols...</guimenuitem> menu item, which launches the FOV Editor: +</para> +<screenshot> +<screeninfo>Field-of-View Symbols Editor</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="fovdialog.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>FOV Symbol Editor</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The list of defined FOV symbols is displayed on the left. On the right are buttons for +adding a new symbol, editing the highlighted symbol's properties, and removing the +highlighted symbol from the list. Note that you can even modify or remove the four +predefined symbols (if you remove all symbols, the four defaults will be restored the +next time you start &kstars;). Below these three buttons is a graphical preview display +showing the highlighted symbol from the list. When the <guibutton>New...</guibutton> or +<guibutton>Edit...</guibutton> button is pressed, the <guilabel>New FOV Symbol</guilabel> +window is opened: +</para> + +<screenshot> +<screeninfo>New Field-of-View Symbol</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="newfov.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>New FOV Symbol</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +<indexterm><primary>Field-of-View Symbols</primary><secondary>Defining New</secondary></indexterm> +This window lets you modify the four properties that define a FOV symbol: name, size, +shape, and color. The angular size for the symbol can either be entered directly in the +<guilabel>Field of View</guilabel> edit box, or you can use the Eyepiece/Camera Tabs to +calculate the field-of-view angle, given parameters of your telescope/eyepiece or +telescope/camera setup. The four available shapes are: Circle, Square, Crosshairs, and +Bullseye. Once you have specified all four parameters, press <guibutton>Ok</guibutton>, +and the symbol will appear in the list of defined symbols. It will also be available +from the <guimenu>Settings</guimenu> | <guisubmenu>FOV</guisubmenu> menu. +</para> +</listitem> +</itemizedlist> + +</sect1> + +</chapter> diff --git a/doc/kstars/cpoles.docbook b/doc/kstars/cpoles.docbook new file mode 100644 index 00000000..c5f28957 --- /dev/null +++ b/doc/kstars/cpoles.docbook @@ -0,0 +1,58 @@ +<sect1 id="ai-cpoles"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>The Celestial Poles</title> +<indexterm><primary>Celestial Poles</primary> +<seealso>Equatorial Coordinates</seealso> +</indexterm> +<para> +The sky appears to drift overhead from east to west, completing a full circuit +around the sky in 24 (<link linkend="ai-sidereal">Sidereal</link>) hours. This +phenomenon is due to the spinning of the Earth on its axis. The Earth's +spin axis intersects the <link linkend="ai-csphere">Celestial Sphere</link> at +two points. These points are the <firstterm>Celestial Poles</firstterm>. As the +Earth spins; they remain fixed in the sky, and all other points seem to rotate +around them. The celestial poles are also the poles of the <link +linkend="equatorial">Equatorial Coordinate System</link>, meaning +they have <firstterm>Declinations</firstterm> of +90 degrees and -90 degrees +(for the North and South celestial poles, respectively). +</para><para> +The North Celestial Pole currently has nearly the same coordinates as +the bright star <firstterm>Polaris</firstterm> (which is Latin for <quote>Pole Star</quote>). +This makes Polaris useful for navigation: not only is it always above the North +point of the horizon, but its <link +linkend="horizontal">Altitude</link> angle is always (nearly) +equal to the observer's <link linkend="ai-geocoords">Geographic Latitude</link> +(however, Polaris can only be seen from locations in the Northern hemisphere). +</para><para> +The fact that Polaris is near the pole is purely a coincidence. In fact, +because of <link linkend="ai-precession">Precession</link>, Polaris is only near +the pole for a small fraction of the time. +</para> +<tip> +<para>Exercises:</para> +<para> +Use the <guilabel>Find Object</guilabel> window +(<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>) to locate +Polaris. Notice that its Declination is almost (but not exactly) +90 degrees. +Compare the Altitude reading when focused on Polaris to your location's +geographic latitude. They are always within one degree of each other. +They are not exactly the same because Polaris isn't exactly at the Pole. +(you can point exactly at the pole by switching to Equatorial +coordinates, and pressing the up-arrow key until the sky stops scrolling). +</para><para> +Use the <guilabel>Time Step</guilabel> spinbox in the toolbar to accelerate time + to a +step of 100 seconds. You can see the entire sky appears to rotate around +Polaris, while Polaris itself remains nearly stationary. +</para><para> +We said that the celestial pole is the pole of the Equatorial coordinate +system. What do you think is the pole of the horizontal (Altitude/Azimuth) +coordinate system? (The <link linkend="ai-zenith">Zenith</link>). +</para> +</tip> +</sect1> diff --git a/doc/kstars/credits.docbook b/doc/kstars/credits.docbook new file mode 100644 index 00000000..8c946366 --- /dev/null +++ b/doc/kstars/credits.docbook @@ -0,0 +1,75 @@ +<chapter id="credits"> +<title>Credits and License</title> + +<para>&kstars;</para> +<para> +Program copyright 2001-2003 The &kstars; Team <email>kstars@30doradus.org</email> +</para> + +<para> +The &kstars; Team: +<itemizedlist> +<listitem><para>Jason Harris <email>kstars@30doradus.org</email></para> +</listitem> +<listitem><para>Jasem Mutlaq <email>mutlaqja@ku.edu</email></para> +</listitem> +<listitem><para>Pablo de Vicente <email>pvicentea@wanadoo.es</email></para> +</listitem> +<listitem><para>Heiko Evermann <email>heiko@evermann.de</email></para> +</listitem> +<listitem><para>Thomas Kabelmann <email>tk78@gmx.de</email></para> +</listitem> +<listitem><para>Mark Hollomon <email>mhh@mindspring.com</email></para> +</listitem> +<listitem><para>Carsten Niehaus <email>cniehaus@gmx.de</email></para> +</listitem> +</itemizedlist> +</para> + +<para> +Data Sources: +<itemizedlist> +<listitem> +<para>Object catalogs and planet position tables: <ulink +url="http://adc.gsfc.nasa.gov">NASA Astronomical Data Center</ulink></para> +</listitem> +<listitem> +<para>Detailed credit information for all of the images used in the program +is presented in the file README.images +</para> +</listitem> +</itemizedlist> +</para> +<para> +References: +<itemizedlist> +<listitem><para><quote>Practical Astronomy With Your +Calculator</quote> by Peter Duffet-Smith</para></listitem> +<listitem><para><quote>Astronomical Algorithms</quote> by Jean +Meeus</para></listitem> +</itemizedlist> +</para> + +<para> Special thanks: To the &kde; and &Qt; developers for providing +the world with a peerless set of free <acronym>API</acronym> +libraries. To the <application>KDevelop</application> team, for their +excellent <acronym>IDE</acronym>, which made developing &kstars; so +much easier and more fun. To everyone on the +<application>KDevelop</application> message board, the &kde; +mailing lists, and on irc.kde.org, for answering our frequent +questions. Thank you to Anne-Marie Mahfouf, for inviting &kstars; to +join the &kde;-Edu module. Finally, thanks to everyone who has +submitted bug reports and other feedback. Thank you, everyone. +</para> + +<para> +Documentation copyright 2001-2003 Jason Harris and the KStars Team +<email>kstars@30doradus.org</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> +&underGPL; <!-- GPL License --> + +</chapter> diff --git a/doc/kstars/csphere.docbook b/doc/kstars/csphere.docbook new file mode 100644 index 00000000..913463ff --- /dev/null +++ b/doc/kstars/csphere.docbook @@ -0,0 +1,28 @@ +<sect1 id="ai-csphere"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>The Celestial Sphere</title> +<indexterm><primary>Celestial Sphere</primary> +<seealso>Celestial Coordinate Systems</seealso> +</indexterm> +<para> +The celestial sphere is an imaginary sphere of gigantic radius, centered +on the Earth. All objects which can be seen in the sky can be thought +of as lying on the surface of this sphere. +</para><para> +Of course, we know that the objects in the sky are not on the surface of +a sphere centered on the Earth, so why bother with such a construct? +Everything we see in the sky is so very far away, that their distances +are impossible to gauge just by looking at them. Since their distances +are indeterminate, you only need to know the <emphasis>direction</emphasis> +toward the object to locate it in the sky. In this sense, the celestial sphere +model is a very practical model for mapping the sky. +</para><para> +The directions toward various objects in the sky can be quantified by +constructing a <link linkend="ai-skycoords">Celestial Coordinate System</link>. +</para> +</sect1> diff --git a/doc/kstars/darkmatter.docbook b/doc/kstars/darkmatter.docbook new file mode 100644 index 00000000..7f094770 --- /dev/null +++ b/doc/kstars/darkmatter.docbook @@ -0,0 +1,119 @@ +<sect1 id="ai-darkmatter"> + +<sect1info> +<author> +<firstname>Jasem</firstname> +<surname>Mutlaq</surname> +<affiliation><address> +</address></affiliation> +</author> +</sect1info> + +<title>Dark Matter</title> +<indexterm><primary>Dark Matter</primary> +</indexterm> + +<para> +Scientists are now quite comfortable with the idea that 90% of the +mass is the universe is in a form of matter that cannot be seen. +</para> + +<para> Despite comprehensive maps of the nearby universe that cover +the spectrum from radio to gamma rays, we are only able to account of +10% of the mass that must be out there. As Bruce H. Margon, an +astronomer at the University of Washington, told the New York Times in +2001: <citation>It's a fairly embarrassing situation to admit that we +can't find 90 percent of the universe</citation>. </para> + +<para> The term given this <quote>missing mass</quote> is +<firstterm>Dark Matter</firstterm>, and those two words pretty well +sum up everything we know about it at this point. We know there is +<quote>Matter</quote>, because we can see the effects of its +gravitational influence. However, the matter emits no detectable +electromagnetic radiation at all, hence it is <quote>Dark</quote>. +There exist several theories to account for the missing mass ranging +from exotic subatomic particles, to a population of isolated black +holes, to less exotic brown and white dwarfs. The term <quote>missing +mass</quote> might be misleading, since the mass itself is not +missing, just its light. But what is exactly dark matter and how do +we really know it exists, if we cannot see it? </para> + +<para> +The story began in 1933 when Astronomer Fritz Zwicky was studying the +motions of distant and massive clusters of galaxies, specifically the +Coma cluster and the Virgo cluster. Zwicky estimated the mass of each +galaxy in the cluster based on their luminosity, and added up all of +the galaxy masses to get a total cluster mass. He then made a second, +independent estimate of the cluster mass, based on measuring the +spread in velocities of the individual galaxies in the cluster. +To his suprise, this second <firstterm>dynamical mass</firstterm> +estimate was <emphasis>400 times</emphasis> larger than the estimate +based on the galaxy light. +</para> + +<para> +Although the evidence was strong at Zwicky's time, it was not until +the 1970s that scientists began to explore this discrepancy +comprehensively. It was at this time that the existence of Dark +Matter began to be taken seriously. The existence of such matter +would not only resolve the mass deficit in galaxy clusters; it +would also have far more reaching consequences for the evolution and +fate of the universe itself. +</para> + +<para> +Another phenomenon that suggested the need for dark matter is the +rotational curves of <firstterm>Spiral Galaxies</firstterm>. Spiral Galaxies +contain a large population of stars that orbit the Galactic center on +nearly circular orbits, much like planets orbit a star. Like +planetary orbits, stars with larger galactic orbits are expected to +have slower orbital speeds (this is just a statement of Kepler's 3rd Law). +Actually, Kepler's 3rd Law only applies to stars near the perimeter of a Spiral +Galaxy, because it assumes the mass enclosed by the orbit to be +constant. +</para> + +<para> +However, astronomers have made observations of the orbital speeds of +stars in the outer parts of a large number of spiral galaxies, and +none of them follow Kepler's 3rd Law as expected. Instead of falling +off at larger radii, the orbital speeds remain remarkably constant. +The implication is that the mass enclosed by larger-radius orbits +increases, even for stars that are apparently near the edge of the +galaxy. While they are near the edge of the luminous part of the +galaxy, the galaxy has a mass profile that apparently continues well +beyond the regions occupied by stars. +</para> + +<para> +Here is another way to think about it: Consider the stars near the +perimeter of a spiral galaxy, with typical observed orbital +velocities of 200 kilometers per second. If the galaxy consisted of +only the matter that we can see, these stars would very quickly fly +off from the galaxy, because their orbital speeds are four times +larger than the galaxy's escape velocity. Since galaxies are not seen +to be spinning apart, there must be mass in the galaxy that we are not +accounting for when we add up all the parts we can see. +</para> + +<para> Several theories have surfaced in literature to account for the +missing mass such as <acronym>WIMP</acronym>s (Weakly Interacting +Massive Particles), <acronym>MACHO</acronym>s (MAssive Compact Halo +Objects), primordial black holes, massive neutrinos, and others; each +with their pros and cons. No single theory has yet been accepted by +the astronomical community, because we so far lack the means to +conclusively test one theory against the other. </para> + +<tip> +<para> +You can see the galaxy clusters that Professor Zwicky studied to +discover Dark Matter. Use the &kstars; Find Object Window +(<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>) to +center on <quote>M 87</quote> to find the Virgo Cluster, and on +<quote>NGC 4884</quote> to find the Coma Cluster. You may have to +zoom in to see the galaxies. Note that the Virgo Cluster appears to +be much larger on the sky. In reality, Coma is the larger cluster; +it only appears smaller because it is further away. +</para> +</tip> +</sect1> diff --git a/doc/kstars/dcop.docbook b/doc/kstars/dcop.docbook new file mode 100644 index 00000000..b17539bf --- /dev/null +++ b/doc/kstars/dcop.docbook @@ -0,0 +1,229 @@ +<chapter id="dcop"> +<title>Scripting KStars: The DCOP Interface</title> +<para> +One of the goals of &kstars; is to provide the ability to playback +complicated behaviors from a script. This will allow you to +create <quote>virtual tours</quote> of the heavens, and will enable +teachers to construct classroom demos to illustrate certain +astronomical concepts. It is already possible to write such scripts +for &kstars;, although not all of the desired functions have been +included. Also, while we will eventually have a GUI-based script +builder tool, the scripts must currently be written by hand. This +chapter will explain how to write &kstars; scripts. +</para> +<para> +The &kde; architecture provides the necessary framework for scriptable +applications via the <abbrev>DCOP</abbrev> interface. +<abbrev>DCOP</abbrev> stands for <quote>Desktop Communication +Protocol</quote>; through <abbrev>DCOP</abbrev>, &kde; applications +can be controlled by other applications, from a terminal prompt, or +through a text script. +</para> + +<sect1 id="dcop-interface"> +<title>DCOP Functions</title> +<para> +The &kstars; <abbrev>DCOP</abbrev> Interface includes the following +functions: + +<itemizedlist> +<listitem><para><function> +lookTowards( const QString direction )</function>: +Point the display focus in a direction specified by the argument. +This can be the name of any object in the sky, or one of the following +directional words or abbreviations: zenith (or z), north (n), +northeast (ne), east (e), southeast (se), south (s), southwest(sw), +west(w), northwest (nw). +</para></listitem> + +<listitem><para><function> +setRaDec( double ra, double dec )</function>: +Point the display focus at the specified equatorial coordinates. +</para></listitem> + +<listitem><para><function> +setAltAz(double alt, double az)</function>: +Point the display focus at the specified horizontal coordinates. +</para></listitem> + +<listitem><para><function> +zoomIn()</function>: +Increase the display's Zoom level. +</para></listitem> + +<listitem><para><function> +zoomOut()</function>: +Decrease the display's Zoom level. +</para></listitem> + +<listitem><para><function> +defaultZoom()</function>: +Reset the display to Zoom level = 3 (the default). +</para></listitem> + +<listitem><para><function> +setLocalTime(int yr, int mth, int day, int hr, int min, int sec)</function>: +Set the simulation clock to the specified date and time. +</para></listitem> + +<listitem><para><function> +waitFor( double t )</function>: +Pause for t seconds before continuing with subsequent script commands. +</para></listitem> + +<listitem><para><function> +waitForKey( const QString k )</function>: +Halt the script execution until the user presses the specified key. +At this point, you cannot specify combination keystrokes (such as +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>); just use +simple keys. You can type <quote>space</quote> to indicate the +spacebar. +</para></listitem> + +<listitem><para><function> +setTracking( bool track )</function>: +Toggle whether tracking mode is engaged. +</para></listitem> + +<listitem><para><function> +changeViewOption( const QString option, const QString value )</function>: +Adjust a view option. There are dozens and dozens of options available; +basically everything you can change in the <guilabel>Configure &kstars; +Window</guilabel> can be changed here as well. The first argument is +the name of the option (the names are taken from the +<filename>kstarsrc</filename> configuration file), and the second +argument is the desired value. The argument parser is designed to be +robust, so if you accidentally send it bad data it should fail +gracefully. +</para></listitem> + +<listitem><para><function> +setGeoLocation( const QString city, const QString province, +const QString country )</function>: +Change the observing location to the specified city. If no city matching +the argument strings is found, then nothing happens. +</para></listitem> + +<listitem><para><function> +stop()</function> [clock]: +Halt the simulation clock. +</para></listitem> + +<listitem><para><function> +start()</function> [clock]: +Start the simulation clock. +</para></listitem> + +<listitem><para><function> +setScale(float s)</function> [clock]: +Set the rate of the simulation clock. s=1.0 corresponds to real time; +2.0 is twice as fast as real-time, etc. +</para></listitem> +</itemizedlist> +</para> +</sect1> + +<sect1 id="dcop-test"> +<title>Testing the DCOP Functions</title> +<para> +You can try out the DCOP functions very easily using the +<application>kdcop</application> program. When you run +<application>kdcop</application>, you will see a tree-list of all +running programs; if &kstars; is running it will be listed. Most of +the <abbrev>DCOP</abbrev> functions are listed under the +<quote>KStarsInterface</quote> heading, but the clock functions are +listed under <quote>clock</quote>. Double-click on any function to +execute it. If the function requires arguments, a window will open +in which you can input the values. +</para> +</sect1> + +<sect1 id="dcop-script"> +<title>Writing a DCOP Script</title> +<para> +<abbrev>DCOP</abbrev> functions can also be called from the UNIX +command line, and these can be encapsulated in a script. We will +create an example script that switches to Equatorial coordinates, +points the display at the Moon, zooms in a bit, and accelerates +the clock to 1 hour per second. After tracking the Moon +for 20 seconds, the clock is paused and the display zooms out. +You can use this script as a template for making new scripts. +I will list the entire script first, and then explain its various +parts. +</para> +<para> +<programlisting> +#!/bin/bash +#KStars script: Track the Moon! +# +KSTARS=`dcopfind -a 'kstars*'` +MAIN=KStarsInterface +CLOCK=clock#1 +dcop $KSTARS $MAIN changeViewOption UseAltAz false +dcop $KSTARS $MAIN lookTowards Moon +dcop $KSTARS $MAIN defaultZoom +dcop $KSTARS $MAIN zoomIn +dcop $KSTARS $MAIN zoomIn +dcop $KSTARS $MAIN zoomIn +dcop $KSTARS $MAIN zoomIn +dcop $KSTARS $MAIN zoomIn +dcop $KSTARS $CLOCK setScale 3600. +dcop $KSTARS $CLOCK start +dcop $KSTARS $MAIN waitFor 20. +dcop $KSTARS $CLOCK stop +dcop $KSTARS $MAIN defaultZoom +## +</programlisting> +</para> +<para> +Save this script to a file. The filename can be anything you like; I +suggest something descriptive like +<filename>trackmoon.kstars</filename>. Then type the following command +to make the script executable: +<userinput><command>chmod</command> <option>a+x</option> +<parameter>trackmoon.kstars</parameter> +</userinput>. The script can then be executed at any time by typing +<userinput><command>./trackmoon.kstars</command></userinput> in the +folder which contains the script. Note that the script will only +work if an instance of &kstars; is already running. You can use the +<command>dcopstart</command> command in a script to launch a new instance +&kstars;. +</para> +<para> +Now to the explanation of the script. The top line identifies the file +as a <command>BASH</command> shell script. The following two lines +are <firstterm>comments</firstterm> (any line beginning with +<quote>#</quote> is a comment, and is ignored by the shell). The next +three lines define some convenience variables that will be used later. +The <varname>KSTARS</varname> variable identifies the currently-running +&kstars; process, using the <command>dcopfind</command> command. +<varname>MAIN</varname> and <varname>CLOCK</varname> identify the +two <abbrev>DCOP</abbrev> interfaces associated with &kstars;. +</para> +<para> +The remainder of the script is the actual list of <abbrev>DCOP</abbrev> +calls. The first command sets the display to use Equatorial +coordinates by setting the <quote>UseAltAz</quote> option to +<quote>false</quote> (again, you can see a list of all options that +<quote>changeViewOption</quote> can use by examining your +<filename>kstarsrc</filename> configuration file). The next command +centers the display on the Moon, and automatically engages tracking. +We then set the default zoom level, and then zoom in five times. +Next, the clock's timescale is set to 1 hour per second (3600 seconds +is one hour), and the clock is started (in case it was not already +running). The next line pauses the script for 20 seconds while we +track the Moon as it moves across the sky. Finally, we stop the clock +and reset the zoom level to its default setting. +</para> +<para> +We hope you enjoy the scripting abilities of KStars. If you create an +interesting script, please email it to +<email>kstars@30doradus.org</email>; we would like to see what you have done, +and may post some scripts on our webpage. Also, if you have any +ideas for how to improve scripting (or any part of &kstars;), let us +know at <email>kstars-devel@lists.sourceforge.net</email> or submit a +wishlist item to bugzilla. +</para> +</sect1> +</chapter> + diff --git a/doc/kstars/detaildialog.png b/doc/kstars/detaildialog.png Binary files differnew file mode 100644 index 00000000..9813dfd8 --- /dev/null +++ b/doc/kstars/detaildialog.png diff --git a/doc/kstars/details.docbook b/doc/kstars/details.docbook new file mode 100644 index 00000000..4defd377 --- /dev/null +++ b/doc/kstars/details.docbook @@ -0,0 +1,113 @@ +<sect1 id="tool-details"> +<title>Object Details Window</title> +<indexterm><primary>Tools</primary> +<secondary>Object Details Window</secondary></indexterm> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Details</secondary></indexterm> + +<screenshot> +<screeninfo> +The Object Details Window +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="detaildialog.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Object Details Window</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The Object Details Window presents advanced data available about +a specific object in the sky. To access this tool, +<mousebutton>right</mousebutton>-click on any object, and select the +<guimenuitem>Details...</guimenuitem> item from the popup menu. +</para> +<para> +The window is divided into a number of Tabs. In the +<guilabel>General</guilabel> Tab, we present basic data about +the current object. This includes names and catalog designations, +object type, and <link linkend="ai-magnitude">magnitude</link> +(brightness). Also shown are the object's Equatorial and Horizontal +coordinates, as well as its rise, set and transit times. +</para> +<para> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Internet Links</secondary> +<tertiary>Customizing</tertiary></indexterm> +In the <guilabel>Links</guilabel> tab, you can manage the internet +links associated with this object. The Image and Information links +associated with the object are listed. These are the links that +appear in the popup menu when the object is +<mousebutton>right</mousebutton>-clicked. You can add custom +links to the object with the <guibutton>Add Link...</guibutton> +button. This will open a window in which you fill in the URL and link +text for the new link (you can also test the URL in the web browser +from this window). Keep in mind that the custom link can easily point +to a file on your local disk, so you can use this feature to index +your personal astronomical images or observing logs. +</para> +<para> +You can also modify or remove any link using the +<guibutton>Edit Link...</guibutton> and +<guibutton>Remove Link...</guibutton> buttons. +</para> +<para> +The <guilabel>Advanced</guilabel> Tab allows you to query professional +astronomical databases on the internet for information regarding the +current object. To use these databases, simply highlight the +desired database in the list, and press the <guibutton>View</guibutton> +button to see the results of your query in a web browser window. The +query is made using the primary name of the object you clicked on to +open the Details Dialog. The following databases are available for +querying: + +<itemizedlist> +<listitem><para>High Energy Astrophysical Archive (HEASARC). Here you +can retrieve data about the current object from a number of +<quote>High-energy</quote> observatories, which covers the +Ultraviolet, X-ray and Gamma Ray portions of the electromagnetic +spectrum.</para></listitem> +<listitem><para>Multimission Archive at Space Telescope (MAST). +The Space Telescope Science Institute provides access to the entire +collection of images and spectra taken with the Hubble Space +Telescope, as well as several other space-based observatories. +</para></listitem> +<listitem><para>NASA Astrophysical Data System (ADS). This +incredible bibliographic database encompass the entire body of +literature published in international peer-review Journals about +astronomy and astrophysics. The database is divided into four +general subject areas (Astronomy and Astrophysics, Astrophysics +Preprints, Instrumentation, and Physics and Geophysics). Each of these +has three sub-nodes that query the database +in different ways. <quote>Keyword search</quote> will return articles +which listed the object's name as a keyword. <quote>Title word +search</quote> will return articles which included the object name in +their Title, and the <quote>Title & Keyword search</quote> uses +both options together. +</para></listitem> +<listitem><para>NASA/IPAC Extragalactic Database (NED). NED provides +encapsulated data and bibliographic links about +extragalactic objects. You should only use NED if your target is +extragalactic; &ie; if it is itself a galaxy. +</para></listitem> +<listitem><para>Set of Identifications, Measurements, and Bibliography +for Astronomical Data (SIMBAD). SIMBAD is similar to NED, except it +provides data about all kinds of objects, not just galaxies. +</para></listitem> +<listitem><para>SkyView provides images from All-Sky surveys that have +been performed in dozens of different parts of the spectrum, from +Gamma Rays to the Radio. The &kstars; interface will retrieve an image +from any of these surveys, centered on the selected object. +</para></listitem> +</itemizedlist> +</para> +<para> +Finally, in the <guilabel>Log</guilabel> Tab, you can type in some text +that will remain associated with this object's Details window. +You could use this to attach personal observing notes, for example. +</para> +</sect1> + diff --git a/doc/kstars/devicemanager.png b/doc/kstars/devicemanager.png Binary files differnew file mode 100644 index 00000000..6268a3ec --- /dev/null +++ b/doc/kstars/devicemanager.png diff --git a/doc/kstars/dumpmode.docbook b/doc/kstars/dumpmode.docbook new file mode 100644 index 00000000..19fdbcf8 --- /dev/null +++ b/doc/kstars/dumpmode.docbook @@ -0,0 +1,67 @@ +<chapter id="dumpmode"> +<title>Command-Line mode for Image Generation</title> +<indexterm><primary>Image-dump Mode</primary></indexterm> + +<para> +You can use &kstars; to generate an image of the sky +without actually launching the <acronym>GUI</acronym> +portion of the program. To use this feature, start +&kstars; from a command prompt using arguments to +specify the filename for the image, as well as the +desired image dimensions: + +<cmdsynopsis> +<command>kstars</command> +<arg choice="plain">--dump</arg> +<arg>--filename <replaceable>kstars.png</replaceable></arg> +<arg>--height <replaceable>640</replaceable></arg> +<arg>--width <replaceable>480</replaceable></arg> +<arg>--script <replaceable>myscript.kstars</replaceable></arg> +<arg>--date <replaceable>"4 July 1976 +12:30:00"</replaceable></arg> +</cmdsynopsis> +</para> +<para> +If no filename is specified, it generates a file +named <filename>kstars.png</filename>. It will attempt to +generate an image that matches the extension of your filename. +The following extensions are recognized: <quote>png</quote>, +<quote>jpg</quote>, <quote>jpeg</quote>, <quote>gif</quote>, +<quote>pnm</quote>, and <quote>bmp</quote>. If the filename +extension is not recognized, it defaults to the +<acronym>PNG</acronym> image type. +</para> +<para> +Likewise, if the image width and height are not specified, +they default to 640 and 480, respectively. +</para> +<para> +By default, &kstars; will read in the options values stored in +your <filename>$KDEHOME/share/config/kstarsrc</filename> file +to determine where the image will be centered, and how it is +rendered. This means you need to run &kstars; in normal GUI +mode, and exit the program when it is set up with the desired +options for the generated images. This is not very flexible, +so we also provide the ability to execute a &kstars; +<acronym>DCOP</acronym> script to set the scene before +generating the image. The filename you specify as the +script argument should be a valid &kstars; +<acronym>DCOP</acronym> script, such as one created with the +<link linkend="tool-scriptbuilder">Script Builder Tool</link>. +The script can be used to set where the image is pointing, +set the geographic location, set the time and date, change the +Zoom level, and adjust other view options. Some of the +<acronym>DCOP</acronym> functions make no sense in non-GUI +mode (such as <function>waitForKey()</function>); if these +functions are encountered while parsing the script, they are +simply ignored. +</para> +<para> +By default, &kstars; will use the system CPU time and date for +generating the image. Alternatively, you may specify a time +and date with the <quote>--date</quote> argument. You can also +use this argument for specifying the startup date in normal +GUI mode. +</para> + +</chapter> diff --git a/doc/kstars/ecliptic.docbook b/doc/kstars/ecliptic.docbook new file mode 100644 index 00000000..3061dd1b --- /dev/null +++ b/doc/kstars/ecliptic.docbook @@ -0,0 +1,58 @@ +<sect1 id="ai-ecliptic"> +<sect1info> +<author> +<firstname>John</firstname> +<surname>Cirillo</surname> +</author> +</sect1info> +<title>The Ecliptic</title> +<indexterm><primary>Ecliptic</primary> +<seealso>Ecliptic Coordinates</seealso> +</indexterm> +<para> +The ecliptic is an imaginary <link linkend="ai-greatcircle">Great Circle</link> +on the <link linkend="ai-csphere">Celestial Sphere</link> along which the Sun +appears to move over the course of a year. Of course, it is really the +Earth's orbit around the Sun causing the change in the Sun's apparent +direction. The ecliptic is inclined from the <link linkend="ai-cequator">Celestial +Equator</link> by 23.5 degrees. The two points where the Ecliptic crosses +the Celestial Equator are known as the <link +linkend="ai-equinox">Equinoxes</link>. +</para><para> +Since our solar system is relatively flat, the orbits of the planets are +also close to the plane of the ecliptic. In addition, the constellations of the +zodiac are located along the ecliptic. This makes the ecliptic a very useful +line of reference to anyone attempting to locate the planets or the +constellations of the zodiac, since they all literally <quote>follow the +Sun</quote>. +</para><para> +Because of the 23.5-degree tilt of the Ecliptic, the +<firstterm>Altitude</firstterm> of the Sun at noon changes over the course of the +year, as it follows the path of the Ecliptic across the sky. This causes the +seasons. In the Summer, the Sun is high in the sky at noon, +and it remains above the <link linkend="ai-horizon">Horizon</link> for more than +twelve hours. Whereas, in the winter, the Sun is low in the sky at noon, and remains +above the Horizon for less than twelve hours. In addition, sunlight is received at +the Earth's surface at a more direct angle in the Summer, which means that a given +area at the surface receives more energy per second in the Summer than in Winter. +The differences in day duration and in energy received per unit area lead to the +differences in temperature we experience in Summer and Winter. +</para> +<tip> +<para>Exercises:</para> +<para> +Make sure your location is set to somewhere that is not very near the equator +for these experiments. Open the <guilabel>Configure &kstars;</guilabel> window, and +switch to Horizontal coordinates, with the Opaque Ground shown. Open the +<guilabel>Set Time</guilabel> window +(<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>),and change the +Date to sometime in the middle of Summer, and the Time to 12:00 Noon. Back in +the Main Window, point toward the Southern Horizon (press <keycap>S</keycap>). +Note the height of the Sun above the Horizon at Noon in the Summer. Now, change +the Date to something in the middle of Winter (but keep the Time at 12:00 Noon). +The Sun is now much lower in the Sky. You will also notice that the day durations +are different if you open the <guilabel>What's Up Tonight?</guilabel> tool for +each date. +</para> +</tip> +</sect1> diff --git a/doc/kstars/ellipticalgalaxies.docbook b/doc/kstars/ellipticalgalaxies.docbook new file mode 100644 index 00000000..eaa84783 --- /dev/null +++ b/doc/kstars/ellipticalgalaxies.docbook @@ -0,0 +1,115 @@ +<sect1 id="ai-ellipgal"> +<sect1info> +<author> +<firstname>Jasem</firstname> +<surname>Mutlaq</surname> +<affiliation><address> +</address></affiliation> +</author> +</sect1info> + +<title>Elliptical Galaxies</title> +<indexterm><primary>Elliptical Galaxies</primary> +</indexterm> + +<para> Elliptical galaxies are spheroidal concentrations of billions +of stars that resemble Globular Clusters on a grand scale. They have +very little internal structure; the density of stars declines smoothly +from the concentrated center to the diffuse edge, and they can have a +broad range of ellipticities (or aspect ratios). They typically +contain very little interstellar gas and dust, and no young stellar +populations (although there are exceptions to these rules). Edwin +Hubble referred to Elliptical galaxies as <quote>early-type</quote> +galaxies, because he thought that they evolved to become Spiral +Galaxies (which he called <quote>late-type</quote> galaxies). +Astronomers actually now believe the opposite is the case (&ie;, that +Spiral galaxies can turn into Elliptical galaxies), but Hubble's +early- and late-type labels are still used. </para> + +<para> +Once thought to be a simple galaxy type, ellipticals are now known to +be quite complex objects. Part of this complexity is due +to their amazing history: ellipticals are thought to be the end +product of the merger of two Spiral galaxies. You can +view a computer simulation MPEG movie of such a merger at <ulink +url="http://oposite.stsci.edu/pubinfo/pr/2002/11/vid/v0211d3.mpg"> +this NASA HST webpage</ulink> (warning: the file is 3.4 MB). +</para> + +<para> +Elliptical galaxies span a very wide range of sizes and +luminosities, from giant Ellipticals hundreds of thousands of light +years across and nearly a trillion times brighter than the sun, to +dwarf Ellipticals just a bit brighter than the average globular +cluster. They are divided to several morphological classes: +</para> + +<variablelist> +<varlistentry> +<term>cD galaxies:</term> +<listitem><para> +Immense and bright objects that can +measure nearly 1 Megaparsec (3 million light years) across. These +titans are only found near the centers of large, dense clusters of +galaxies, and are likely the result of many galaxy +mergers.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Normal Elliptical galaxies</term> +<listitem><para>Condensed Object with +relatively high central surface brightness. They include the giant +ellipticals (gE'e), intermediate-luminosity ellipticals (E's), and +compact ellipticals.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Dwarf elliptical galaxies (dE's)</term> +<listitem><para> This class of +galaxies is fundamentally different from normal ellipticals. Their +diameters on the order of 1 to 10 kiloparsec with surface brightness +that is much lower than normal ellipticals, giving them a much more +diffuse appearance. They display the same characteristic gradual +decline of star density from a relatively dense core out to a diffuse +periphery.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Dwarf spheroidal galaxies (dSph's)</term> +<listitem><para>Extreme low-luminosity, low +surface-brightness and have only been observed in the vicinity of the +Milky Way, and possibly other very nearby galaxy groups, such as the +Leo group. Their absolute magnitudes are only -8 to -15 mag. +The Draco dwarf spheroidal galaxy has an absolute magnitude of -8.6, +making it fainter than the average globular cluster in the Milky Way! +</para></listitem> +</varlistentry> + +<varlistentry> +<term>Blue compact dwarf galaxies (BCD's)</term> +<listitem> +<para> Small galaxies that are unusually +blue. Thehave photometric colors of B-V = 0.0 to 0.30 mag, which is +typical for relatively young stars of <firstterm>spectral type</firstterm> A. +This suggests that BCDs +are currently actively forming stars. These systems also have +abundant interstellar gas (unlike other Elliptical galaxies). +</para></listitem> +</varlistentry> +</variablelist> + +<tip> +<para> +You can see examples of Elliptical galaxies in &kstars;, using the Find +Object window +(<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>). +Search for NGC 4881, which is the Giant cD galaxy in the Coma +cluster of galaxies. M 86 is a normal Elliptical galaxy in the Virgo +cluster of galaxies. M 32 is a dwarf Elliptical that is a satellite +of our neighbor, the Andromeda galaxy (M 31). M 110 is another +satellite of M 31 that is a borderline dwarf spheroidal galaxy +(<quote>borderline</quote> because it is somewhat brighter than most other +dwarf spheroidals). +</para> +</tip> +</sect1> diff --git a/doc/kstars/equinox.docbook b/doc/kstars/equinox.docbook new file mode 100644 index 00000000..6d98ccc6 --- /dev/null +++ b/doc/kstars/equinox.docbook @@ -0,0 +1,37 @@ +<sect1 id="ai-equinox"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>The Equinoxes</title> +<indexterm><primary>Equinoxes</primary> +<seealso>Celestial Equator</seealso> +<seealso>Ecliptic</seealso> +</indexterm> +<para> +Most people know the Vernal and Autumnal Equinoxes as +calendar dates, signifying the beginning of the Northern hemisphere's Spring +and Autumn, respectively. Did you know that the equinoxes are also positions in +the sky? +</para><para> +The <link linkend="ai-cequator">Celestial Equator</link> and the +<link linkend="ai-ecliptic">Ecliptic</link> are two +<link linkend="ai-greatcircle">Great Circles</link> on the +<link linkend="ai-csphere">Celestial Sphere</link>, set at an angle of 23.5 +degrees. The two points where they intersect are called the +<firstterm>Equinoxes</firstterm>. The <firstterm>Vernal Equinox</firstterm> +has coordinates RA=0.0 hours, Dec=0.0 degrees. The <firstterm>Autumnal +Equinox</firstterm> has coordinates RA=12.0 hours, Dec=0.0 degrees. +</para><para> +The Equinoxes are important for marking the seasons. Because they are on +the <link linkend="ai-ecliptic">Ecliptic</link>, the Sun passes through each +equinox every year. When the Sun passes through the Vernal Equinox (usually on +March 21st), it crosses the <link linkend="ai-cequator">Celestial Equator</link> +from South to North, signifying the end of Winter for the Northern hemisphere. +Similarly, whenthe Sun passes through the Autumnal Equinox (usually on September +21st), it crosses the Celestial Equator from North to South, signifying the +end of Winter for the Southern hemisphere. +</para> +</sect1> diff --git a/doc/kstars/faq.docbook b/doc/kstars/faq.docbook new file mode 100644 index 00000000..e1ed1d23 --- /dev/null +++ b/doc/kstars/faq.docbook @@ -0,0 +1,274 @@ +<chapter id="faq"> +<title>Questions and Answers</title> + +&reporting.bugs; +&updating.documentation; + +<qandaset id="faqlist"> + +<qandaentry> +<question> +<para>What is the &kstars; Icon?</para> +</question> +<answer> +<para> +The <guiicon>&kstars; Icon</guiicon> is a sextant, a handheld telescope which +was used by navigators on sailing ships back when the stars were important for +navigation. By carefully reckoning the positions of the stars, the navigator +could get an accurate estimate of the ship's current <link +linkend="ai-geocoords">longitude and latitude</link>. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What do the different symbols for deep-sky objects mean?</para> +</question> +<answer> +<para> +The symbol indicates the object type: +<itemizedlist> +<listitem><para>dotted circle: Open Cluster</para></listitem> +<listitem><para>cross-in-circle: Globular Cluster</para></listitem> +<listitem><para>box: Gaseous Nebula</para></listitem> +<listitem><para>diamond: Supernova Remnant</para></listitem> +<listitem><para>circle with outer lines: Planetary Nebula</para></listitem> +<listitem><para>ellipse: Galaxy</para></listitem> +</itemizedlist> +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What do the different colors of Deep-sky objects mean?</para> +</question> +<answer> +<para> +Generally, the different colors indicate to which catalog the object +belongs (Messier, NGC or IC). However, some objects have a different +color which indicates that there are extra images available in the +<link linkend="popup-menu">popup menu</link> (the default +<quote>extras</quote> color is red). +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +Why are there so many more U.S. cities than in other countries? +</para> +</question> +<answer> +<para> +When we started &kstars;, we were unable to find a longitude/latitude +database that covered the globe equitably. However, the &kstars; +community is rapidly overcoming this problem! We have already +received city lists from many users around the world. If you can +contribute to this effort, please send us your list of cities and +coordinates. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +I have added a custom location to &kstars; that I no longer want. How +do I remove it from the program? +</para> +</question> +<answer> +<para> +You will have to edit the +<filename>~/.kde/share/apps/kstars/mycities.dat</filename> file, and +remove the location's line from that file. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why can I not display the ground when using Equatorial +Coordinates?</para> +</question> +<answer> +<para> +The short answer is, this is a temporary limitation. There is a +problem when constructing the filled polygon that represents the ground +when in Equatorial mode. However, it does not make too much sense to draw +the ground in equatorial coordinates, which is why this fix has been given +a low priority. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why do some objects disappear when I am scrolling the +display?</para> +</question> +<answer> +<para> +When the display is in motion, &kstars; must recompute the screen +coordinates of every object in its database, which involves +some pretty heavy trigonometry. When scrolling the display (either +with the arrow keys or by dragging with the mouse), the display may +become slow and jerky, because the computer is having trouble keeping +up. By excluding many of the objects, the computational load is +greatly reduced, which allows for smoother scrolling. You can turn +off this feature in the <guilabel>Configure &kstars;</guilabel> window, +and you can also configure which objects get hidden. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>I do not understand all the terms used in &kstars;. Where can I +learn more about the astronomy behind the program?</para> +</question> +<answer> +<para> +The &kstars; Handbook includes the <link linkend="astroinfo">AstroInfo +Project</link>; a series of short, hyperlinked articles about +astronomical topics that can be explored and illustrated with &kstars;. +AstroInfo is a community effort, like GNUpedia or Everything2. If +you'd like to contribute to AstroInfo, please join our mailing list: +<email>kstars-info@lists.sourceforge.net</email>. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>I want &kstars; to start up with a time and date different from +my system CPU clock. Is this possible?</para> +</question> +<answer> +<para> +Yes; to start kstars with a different time/date, use the +<quote>--date</quote> argument, followed by a date string like +<quote>4 July 1976 12:30:00</quote> +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>I want &kstars; to start up with the simulation clock paused. +Is this possible?</para> +</question> +<answer> +<para> +Yes; to start kstars with the clock paused, simply add the +<quote>--paused</quote> argument to the command line. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How accurate/precise is &kstars;?</para> +</question> +<answer> +<para> +&kstars; is pretty accurate, but it is not (yet) as precise as it can +possibly be. The problem with high-precision calculations is that +you start having to deal with a large number of complicating factors. +If you are not a professional astronomer, you will probably never have a +problem with its accuracy or precision. +</para> +<para> +Here is a list of some of the complicating factors which limit the +program's precision: +<itemizedlist> +<listitem> +<para> +Planet positions are only accurate for dates within 4000 years +or so of the current epoch. The planet positions are predicted using +a Fourier-like analysis of their orbits, as observed over the past few +centuries. We learnt in school that planets follow simple elliptical +orbits around the Sun, but this is not strictly true. It would be true +only if there was only one planet in the Solar system, and if the Sun +and the planet were both point masses. As it is, the planets are +constantly tugging on each other, perturbing the orbits slightly, and +tidal effects also induce precessional wobbling. In fact, recent +analysis suggests that the planets' orbits may not even be stable in +the long term (i.e., millions or billions of years). As a rule of +thumb, you can expect the position of a planet to be accurate to a few +arcseconds between the dates -2000 and 6000. +</para><para> +Pluto is the exception to this; its position is perhaps ten times less +precise than the positions of the other planets. Still, for dates +near the present epoch, its position can be trusted to about an +arcsecond. +</para><para> +The moon's position is the most difficult to predict to high precision. +This is because its motion is quite perturbed by the Earth. Also, +since it is so nearby, even minute effects that would be undetectable +in more distant bodies are easily apparent in the moon. +</para><para> +The objects with the worst long-term precision in the program are the +comets and asteroids. We use a very simplistic orbital model for the +minor planets that does not include third-body perturbations. +Therefore, their positions can only be trusted for dates near the +present epoch. Even for the present epoch, one can expect positional +errors among the minor planets of order 10 arcseconds or more. +</para> +</listitem> +</itemizedlist> +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why do I have to download an improved NGC/IC catalog and Messier +object images? Why not just include them as part of the &kstars; distribution?</para> +</question> +<answer> +<para> +The author of the downloadable NGC/IC catalog has released it with the restriction that it may not be used commercially. For most &kstars; users, this is not a problem. However, it is technically against the &kstars; license (the +<acronym>GPL</acronym>) to restrict usage in this way. We removed the Messier object images from the standard distribution for two reasons: to simply reduce the size of &kstars;, and also because of similar licensing concerns with a couple of the images. The inline images are significantly compressed to a very low quality from their original form, so I doubt there is a real copyright concern, but I did obtain explicit permission from the images' authors to use the few images for which there was any question about it (see <filename>README.images</filename>). Still, just to be absolutely safe, I removed them from the standard distribution, and marked the download archive as being "free for non-commercial use". +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>I am really enjoying the beautiful images I have downloaded through &kstars;! I would like to share them with the world; can I publish a calendar featuring these images (or are there any usage restrictions on the images)?</para> +</question> +<answer> +<para> +It depends on the image, but many of the images restrict against commercial usage. The Image Viewer's statusbar will usually contain information about the image's copyright holder, and what usage restrictions apply. As a rule of thumb: anything published by NASA is in the public domain (including all HST images). For everything else, you can pretty safely assume that the images may not be used commercially without permission. When in doubt, contact the image's copyright holder directly. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Can I help contribute to future versions of &kstars;?</para> +</question> +<answer> +<para> +Yes, definitely! Introduce yourself on our mailing list: +<email>kstars-devel@kde.org</email>. If you want to +help with the coding, download the latest <ulink +url="http://edu.kde.org/kstars/cvs.html">CVS</ulink> version of the +code and dive right in. There are several README files in the +distribution that explain some of the code's subsystems. If you +need ideas of what to work on, see the TODO file. You can submit +patches to kstars-devel, and feel free to post any questions you +have about the code there as well. +</para><para> +If you are not into coding, we can still use your help with i18n, docs, +AstroInfo articles, URL links, bug reports, and feature requests. +</para> +</answer> +</qandaentry> + +</qandaset> +</chapter> diff --git a/doc/kstars/find.png b/doc/kstars/find.png Binary files differnew file mode 100644 index 00000000..0b43abdb --- /dev/null +++ b/doc/kstars/find.png diff --git a/doc/kstars/fitsarea.png b/doc/kstars/fitsarea.png Binary files differnew file mode 100644 index 00000000..7d7f7381 --- /dev/null +++ b/doc/kstars/fitsarea.png diff --git a/doc/kstars/fitsviewer.docbook b/doc/kstars/fitsviewer.docbook new file mode 100644 index 00000000..e6875af5 --- /dev/null +++ b/doc/kstars/fitsviewer.docbook @@ -0,0 +1,59 @@ +<sect1 id="tool-fitsviewer"> +<title><acronym>FITS</acronym> Viewer Tool</title> +<indexterm><primary>Tools</primary> +<secondary>FITS Viewer</secondary> +</indexterm> + +<para>The Flexible Image Transport System (FITS) is the standard format for representing images and data in Astronomy.</para> + +<para>The KStars FITS Viewer tool is integrated with the <link linkend="indi">INDI</link> framework for seamless display and manipulation of captured FITS images. Furthermore, the FITS Viewer can be used to post-process raw data. To open a FITS file, select <guimenuitem>Open FITS...</guimenuitem> from the +<guimenu>File</guimenu> menu, or press <keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>.</para> + +<para>FITS Viewer features:</para> +<itemizedlist> + <listitem><para>Support for 8, 16, 32, IEEE -32, and IEEE -64 bits formats.</para></listitem> + <listitem><para>Histogram with auto, linear, logarithmic, and square-root scales.</para></listitem> + <listitem><para>Image reduction tool.</para></listitem> + <listitem><para>Brightness/Contrast controls.</para></listitem> + <listitem><para>Pan and Zoom.</para></listitem> + <listitem><para>Auto levels.</para></listitem> + <listitem><para>Statistics.</para></listitem> + <listitem><para>FITS header query.</para></listitem> + <listitem><para>Undo/Redo.</para></listitem> +</itemizedlist> + +<screenshot> + <screeninfo>The FITS Viewer Tool</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="fitsarea.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>FITS Viewer Tool</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para>The above diagram illustrates the FITS Viewer work area and window. The tool provides basic functions for image display and processing. FITS data depth is preserved throughout all processing, open, and save functions. While the tool adhere to the FITS standard, it does not support all possible FITS features:</para> +<itemizedlist> + <listitem><para>Support for only <emphasis>one</emphasis> image per file.</para></listitem> + <listitem><para>Support for only 2D data. 1D and 3D data are discarded.</para></listitem> + <listitem><para>No support for WCS (World Coordinate System).</para></listitem> +</itemizedlist> + +<para>The following is a brief description of the tool's functional units:</para> +<itemizedlist> + <listitem><para>Brightness/Contrast: Adjusts brightness and contrast. The function can be CPU and memory intensive for very large FITS.</para></listitem> + <listitem><para>Histogram: Displays one-channel FITS histogram. The user can rescale the image by optionally defining an upper and lower limit for the cutoff region. The rescaling operation (linear, logarithmic, or square-root) may then be applied to the region enclosed by the upper and lower limits.</para></listitem> + <listitem><para>Image reduction: Removes background noise and optical anamolies from the image. Raw CCD images are often processed to remove instrument and temperature noise, in addition to aberrations inherit in the optical system. The function supports three types of raw CCD frames:</para> + <orderedlist> + <listitem><para>Dark Frames</para></listitem> + <listitem><para>Flat Field Frames</para></listitem> + <listitem><para>Dark Flat Field Frames</para></listitem> + </orderedlist> + <para>The user can stack up multiple frames in each category to increase the signal-to-noise ratio. Two combination methods are provided: mean and median. The two methods produce similar results most of the time, but the median method insures that the data is not skewed due to random cosmic ray hits.</para> + </listitem> + <listitem><para>Statistics: Provides simple statistics for minimum and maximum pixel values and the their respective locations. FITS depth, dimension, mean, and standard deviation.</para></listitem> + <listitem><para>FITS header: Displays FITS header information.</para></listitem> +</itemizedlist> +</sect1> diff --git a/doc/kstars/flux.docbook b/doc/kstars/flux.docbook new file mode 100644 index 00000000..ba24ea31 --- /dev/null +++ b/doc/kstars/flux.docbook @@ -0,0 +1,69 @@ +<sect1 id="ai-flux"> + +<sect1info> + +<author> +<firstname>Jasem</firstname> +<surname>Mutlaq</surname> +<affiliation><address> +</address></affiliation> +</author> +</sect1info> + +<title>Flux</title> +<indexterm><primary>Flux</primary> +<seealso>Luminosity</seealso> +</indexterm> + +<para> +The <firstterm>flux</firstterm> is the amount of energy that passes through a unit area each second. +</para> + +<para> +Astronomers use flux to denote the apparent brightness of a celestial body. The apparent brightness is defined as the the amount of light received from a star +above the earth atmosphere passing through a unit area each second. Therefore, the apparent brightness is simply the flux we receive from a star. +</para> + +<para> +The flux measures the <emphasis>rate of flow</emphasis> of energy that passes through each cm^2 (or any unit area) of an object's surface each second. +The detected flux depends on the distance from the source that radiates the energy. This is because the energy has to spread over a volume of space before it reaches us. +Let us assume that we have an imaginary balloon that encloses a star. Each dot on the balloon represents a unit of energy emitted from the star. Initially, the dots in an area +of one cm^2 are in close proximity to each other and the flux (energy emitted per square centimeter per second) is high. After a distance d, the volume and surface area of the +balloon increased causing the dots to <emphasis>spread away</emphasis> from each. Consequently, the number of dots (or energy) enclosed in one cm^2 has decreased as illustrated in Figure 1. +</para> + +<para> +<mediaobject> +<imageobject> +<imagedata fileref="flux.png" format="PNG"/> +</imageobject> +<caption><para><phrase>Figure 1</phrase></para></caption> +</mediaobject> +</para> + +<para> +The flux is inversely proportional to distance by a simple r^2 relation. Therefore, if the distance is doubled, we receive 1/2^2 or 1/4th of the original flux. +From a fundamental standpoint, the flux is the <link linkend="ai-luminosity">luminosity</link> per unit area: + +<mediaobject> +<imageobject> +<imagedata fileref="flux1.png" format="PNG"/> +</imageobject> +</mediaobject> +</para> + +<para> +where (4 * PI * R^2) is the surface area of a sphere (or a balloon!) with a radius R. +Flux is measured in Watts/m^2/s or as commonly used by astronomers: Ergs/cm^2/s. +For example, the luminosity of the sun is L = 3.90 * 10^26 W. That is, in one second the sun radiates 3.90 * 10^26 joules of energy into space. Thus, the flux we receive +passing through one square centimeter from the sun at a distance of one AU (1.496 * 10^13 cm) is: +</para> + +<para> +<mediaobject> +<imageobject> +<imagedata fileref="flux2.png" format="PNG"/> +</imageobject> +</mediaobject> +</para> +</sect1> diff --git a/doc/kstars/flux.png b/doc/kstars/flux.png Binary files differnew file mode 100644 index 00000000..252c1d8d --- /dev/null +++ b/doc/kstars/flux.png diff --git a/doc/kstars/flux1.png b/doc/kstars/flux1.png Binary files differnew file mode 100644 index 00000000..96a078a8 --- /dev/null +++ b/doc/kstars/flux1.png diff --git a/doc/kstars/flux2.png b/doc/kstars/flux2.png Binary files differnew file mode 100644 index 00000000..aacdaea0 --- /dev/null +++ b/doc/kstars/flux2.png diff --git a/doc/kstars/fovdialog.png b/doc/kstars/fovdialog.png Binary files differnew file mode 100644 index 00000000..0135a21c --- /dev/null +++ b/doc/kstars/fovdialog.png diff --git a/doc/kstars/geocoords.docbook b/doc/kstars/geocoords.docbook new file mode 100644 index 00000000..5dd04a8c --- /dev/null +++ b/doc/kstars/geocoords.docbook @@ -0,0 +1,56 @@ +<sect1 id="ai-geocoords"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>Geographic Coordinates</title> +<indexterm><primary>Geographic Coordinate System</primary></indexterm> +<indexterm><primary>Longitude</primary><see>Geographic Coordinate System</see></indexterm> +<indexterm><primary>Latitude</primary><see>Geographic Coordinate System</see></indexterm> +<para> +Locations on Earth can be specified using a spherical coordinate system. +The geographic (<quote>earth-mapping</quote>) coordinate system is aligned +with the spin axis of the Earth. It defines two angles measured from +the center of the Earth. One angle, called the <firstterm>Latitude</firstterm>, +measures the angle between any point and the Equator. The other angle, called +the <firstterm>Longitude</firstterm>, measures the angle +<emphasis>along</emphasis> the Equator from an arbitrary point on the Earth +(Greenwich, England is the accepted zero-longitude point in most modern +societies). +</para><para> +By combining these two angles, any location on Earth can be specified. +For example, Baltimore, Maryland (USA) has a latitude of 39.3 degrees +North, and a longitude of 76.6 degrees West. So, a vector drawn from +the center of the Earth to a point 39.3 degrees above the Equator and +76.6 degrees west of Greenwich, England will pass through Baltimore. +</para><para> +The Equator is obviously an important part of this coordinate system; it +represents the <emphasis>zeropoint</emphasis> of the latitude angle, and the +halfway point between the poles. The Equator is the <firstterm>Fundamental +Plane</firstterm> of the geographic coordinate system. <link +linkend="ai-skycoords">All Spherical Coordinate Systems</link> define such a +Fundamental Plane. +</para><para> +Lines of constant Latitude are called <firstterm>Parallels</firstterm>. They +trace circles on the surface of the Earth, but the only parallel that is a <link +linkend="ai-greatcircle">Great Circle</link> is the Equator (Latitude=0 +degrees). Lines of constant Longitude are called +<firstterm>Meridians</firstterm>. The Meridian passing through Greenwich is the +<firstterm>Prime Meridian</firstterm> (longitude=0 degrees). Unlike Parallels, +all Meridians are great circles, and Meridians are not parallel: they intersect +at the north and south poles. +</para> +<tip> +<para>Exercise:</para> +<para> +What is the longitude of the North Pole? Its latitude +is 90 degrees North. +</para> +<para> +This is a trick question. The Longitude is meaningless at the north pole (and the +south pole too). It has all longitudes at the same time. +</para> +</tip> +</sect1> diff --git a/doc/kstars/geolocator.png b/doc/kstars/geolocator.png Binary files differnew file mode 100644 index 00000000..65c29015 --- /dev/null +++ b/doc/kstars/geolocator.png diff --git a/doc/kstars/greatcircle.docbook b/doc/kstars/greatcircle.docbook new file mode 100644 index 00000000..109fba45 --- /dev/null +++ b/doc/kstars/greatcircle.docbook @@ -0,0 +1,27 @@ +<sect1 id="ai-greatcircle"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>Great Circles</title> +<indexterm><primary>Great Circles</primary> +<seealso>Celestial Sphere</seealso> +</indexterm> +<para> +Consider a sphere, such as the Earth, or the +<link linkend="ai-csphere">Celestial Sphere</link>. The intersection +of any plane with the sphere will result in a circle on the surface of +the sphere. If the plane happens to contain the center of the sphere, +the intersection circle is a <firstterm>Great Circle</firstterm>. +Great circles are the largest circles that can be drawn on a sphere. +Also, the shortest path between any two points on a sphere is always +along a great circle. +</para><para> +Some examples of great circles on the celestial sphere include: the +<link linkend="ai-horizon">Horizon</link>, the +<link linkend="ai-cequator">Celestial Equator</link>, and the +<link linkend="ai-ecliptic">Ecliptic</link>. +</para> +</sect1> diff --git a/doc/kstars/horizon.docbook b/doc/kstars/horizon.docbook new file mode 100644 index 00000000..23f61610 --- /dev/null +++ b/doc/kstars/horizon.docbook @@ -0,0 +1,25 @@ +<sect1 id="ai-horizon"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>The Horizon</title> +<indexterm><primary>Horizon</primary> +<seealso>Horizontal Coordinates</seealso> +</indexterm> +<para> +The <firstterm>Horizon</firstterm> is the line that separates Earth from Sky. +More precisely, it is the line that divides all of the directions you can +possibly look into two categories: those which intersect the Earth, +and those which do not. At many locations, the Horizon is +obscured by trees, buildings, mountains, &etc;. However, if you are on +a ship at sea, the Horizon is strikingly apparent. +</para><para> +The horizon is the <firstterm>Fundamental Plane</firstterm> of the <link +linkend="horizontal">Horizontal Coordinate System</link>. In other +words, it is the locus of points which have an <firstterm>Altitude</firstterm> +of zero degrees. +</para> +</sect1> diff --git a/doc/kstars/hourangle.docbook b/doc/kstars/hourangle.docbook new file mode 100644 index 00000000..fc327446 --- /dev/null +++ b/doc/kstars/hourangle.docbook @@ -0,0 +1,33 @@ +<sect1 id="ai-hourangle"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>Hour Angle</title> +<indexterm><primary>Hour Angle</primary> +<seealso>Local Meridian</seealso> +<seealso>Sidereal Time</seealso> +</indexterm> +<para> +As explained in the <link linkend="ai-sidereal">Sidereal Time</link> article, +the <firstterm>Right Ascension</firstterm> of an object indicates the Sidereal +Time at which it will transit across your <link linkend="ai-meridian">Local +Meridian</link>. An object's <firstterm>Hour Angle</firstterm> is +defined as the difference between the current Local Sidereal Time and the Right +Ascension of the object: +</para><para> +<abbrev>HA</abbrev><subscript>obj</subscript> = +<abbrev>LST</abbrev> - <abbrev>RA</abbrev><subscript>obj</subscript> +</para><para> +Thus, the object's Hour Angle indicates how much Sidereal Time has passed +since the object was on the Local Meridian. It is also the angular distance +between the object and the meridian, measured in hours (1 hour = 15 degrees). +For example, if an object has an hour angle of 2.5 hours, it transited across +the Local Meridian 2.5 hours ago, and is currently 37.5 degrees West of the +Meridian. Negative Hour Angles indicate the time until the +<emphasis>next</emphasis> transit across the Local Meridian. Of course, an Hour +Angle of zero means the object is currently on the Local Meridian. +</para> +</sect1> diff --git a/doc/kstars/index.docbook b/doc/kstars/index.docbook new file mode 100644 index 00000000..14ac543c --- /dev/null +++ b/doc/kstars/index.docbook @@ -0,0 +1,299 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kstars;"> + <!ENTITY package "kdeedu"> + <!ENTITY astroinfo SYSTEM "astroinfo.docbook"> + <!ENTITY blackbody SYSTEM "blackbody.docbook"> + <!ENTITY calc-angdist SYSTEM "calc-angdist.docbook"> + <!ENTITY calc-apcoords SYSTEM "calc-apcoords.docbook"> + <!ENTITY calc-ecliptic SYSTEM "calc-ecliptic.docbook"> + <!ENTITY calc-eqgal SYSTEM "calc-eqgal.docbook"> + <!ENTITY calc-equinox SYSTEM "calc-equinox.docbook"> + <!ENTITY calc-horiz SYSTEM "calc-horizontal.docbook"> + <!ENTITY calc-planetcoords SYSTEM "calc-planetcoords.docbook"> + <!ENTITY calc-precess SYSTEM "calc-precess.docbook"> + <!ENTITY calc-geodetic SYSTEM "calc-geodetic.docbook"> + <!ENTITY calc-dayduration SYSTEM "calc-dayduration.docbook"> + <!ENTITY calc-julian SYSTEM "calc-julianday.docbook"> + <!ENTITY calc-sidereal SYSTEM "calc-sidereal.docbook"> + <!ENTITY calculator SYSTEM "calculator.docbook"> + <!ENTITY cequator SYSTEM "cequator.docbook"> + <!ENTITY colorandtemp SYSTEM "colorandtemp.docbook"> + <!ENTITY commands SYSTEM "commands.docbook"> + <!ENTITY config SYSTEM "config.docbook"> + <!ENTITY contents SYSTEM "ai-contents.docbook"> + <!ENTITY cpoles SYSTEM "cpoles.docbook"> + <!ENTITY credits SYSTEM "credits.docbook"> + <!ENTITY csphere SYSTEM "csphere.docbook"> + <!ENTITY darkmatter SYSTEM "darkmatter.docbook"> + <!ENTITY dumpmode SYSTEM "dumpmode.docbook"> + <!ENTITY ecliptic SYSTEM "ecliptic.docbook"> + <!ENTITY ellipgal SYSTEM "ellipticalgalaxies.docbook"> + <!ENTITY equinox SYSTEM "equinox.docbook"> + <!ENTITY faq SYSTEM "faq.docbook"> + <!ENTITY flux SYSTEM "flux.docbook"> + <!ENTITY geocoords SYSTEM "geocoords.docbook"> + <!ENTITY greatcircle SYSTEM "greatcircle.docbook"> + <!ENTITY horizon SYSTEM "horizon.docbook"> + <!ENTITY hourangle SYSTEM "hourangle.docbook"> + <!ENTITY indi SYSTEM "indi.docbook"> + <!ENTITY install SYSTEM "install.docbook"> + <!ENTITY julianday SYSTEM "julianday.docbook"> + <!ENTITY leapyear SYSTEM "leapyear.docbook"> + <!ENTITY lightcurves SYSTEM "lightcurves.docbook"> + <!ENTITY luminosity SYSTEM "luminosity.docbook"> + <!ENTITY magnitude SYSTEM "magnitude.docbook"> + <!ENTITY meridian SYSTEM "meridian.docbook"> + <!ENTITY parallax SYSTEM "parallax.docbook"> + <!ENTITY precession SYSTEM "precession.docbook"> + <!ENTITY quicktour SYSTEM "quicktour.docbook"> + <!ENTITY retrograde SYSTEM "retrograde.docbook"> + <!ENTITY sidereal SYSTEM "sidereal.docbook"> + <!ENTITY skycoords SYSTEM "skycoords.docbook"> + <!ENTITY spiralgal SYSTEM "spiralgalaxies.docbook"> + <!ENTITY stars SYSTEM "stars.docbook"> + <!ENTITY timezones SYSTEM "timezones.docbook"> + <!ENTITY tool-aavso SYSTEM "lightcurves.docbook"> + <!ENTITY tool-altvstime SYSTEM "altvstime.docbook"> + <!ENTITY tool-calculator SYSTEM "calculator.docbook"> + <!ENTITY tool-details SYSTEM "details.docbook"> + <!ENTITY tool-whatsup SYSTEM "wut.docbook"> + <!ENTITY tool-scriptbuilder SYSTEM "scriptbuilder.docbook"> + <!ENTITY tool-solarsys SYSTEM "solarsys.docbook"> + <!ENTITY tool-jmoons SYSTEM "jmoons.docbook"> + <!ENTITY tool-observinglist SYSTEM "observinglist.docbook"> + <!ENTITY tool-fitsviewer SYSTEM "fitsviewer.docbook"> + <!ENTITY tools SYSTEM "tools.docbook"> + <!ENTITY utime SYSTEM "utime.docbook"> + <!ENTITY zenith SYSTEM "zenith.docbook"> + <!ENTITY % addindex "INCLUDE"> + <!ENTITY % English "INCLUDE"><!-- change language only here --> +]> + +<book lang="&language;"> +<title>The &kstars; Handbook</title> +<bookinfo> + +<authorgroup> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +<affiliation> +<address><email>&Jason.Harris.mail;</email></address> +</affiliation> +</author> + +<othercredit role="developer"> +<firstname>Heiko</firstname> +<surname>Evermann</surname> +<affiliation> +<address><email>&Heiko.Evermann.mail;</email></address> +</affiliation> +<contrib>Core Developer</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Thomas</firstname> +<surname>Kabelmann</surname> +<affiliation> +<address><email>&Thomas.Kabelmann.mail;</email></address> +</affiliation> +<contrib>Core Developer</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Pablo</firstname> +<surname>de Vicente</surname> +<affiliation> +<address><email>&Pablo.de.Vicente.mail;</email></address> +</affiliation> +<contrib>Core Developer</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Jasem</firstname> +<surname>Mutlaq</surname> +<affiliation> +<address><email>mutlaqja@ikarustech.com</email></address> +</affiliation> +<contrib>Core Developer</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Carsten</firstname> +<surname>Niehaus</surname> +<affiliation> +<address><email>cniehaus@gmx.de</email></address> +</affiliation> +<contrib>Core Developer</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Mark</firstname> +<surname>Holloman</surname> +<affiliation> +<address><email>&Mark.Holloman.mail;</email></address> +</affiliation> +<contrib>Core Developer</contrib> +</othercredit> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2001</year><year>2002</year><year>2003</year> +<holder>&Jason.Harris; and the &kstars; Team</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2002-10-08</date> +<releaseinfo>1.0</releaseinfo> + +<abstract> +<para> +&kstars; is a graphical desktop planetarium for &kde;. It depicts an +accurate simulation of the night sky, including stars, constellations, +star clusters, nebulae, galaxies, all planets, the Sun, the Moon, +comets and asteroids. You can see the sky as it appears +from any location on Earth, on any date. The user interface is highly +intuitive and flexible; the display can be panned and zoomed with the +mouse, and you can easily identify objects, and track their motion +across the sky. &kstars; includes many powerful features, yet the +interface is clean and simple, and fun to use. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeedu</keyword> +<keyword>Astronomy</keyword> +<keyword>KStars</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&kstars; lets you explore the night sky from +the comfort of your computer chair. It provides an accurate graphical +representation of the night sky for any date, from any location on +Earth. The display includes 126,000 stars to 9th magnitude (well below +the naked-eye limit), 13,000 deep-sky objects (Messier, NGC, and IC +catalogs), all planets, the Sun and Moon, hundreds of comets and +asteroids, the Milky Way, 88 constellations, and guide lines such as +the <link linkend="ai-cequator">celestial equator</link>, +the <link linkend="ai-horizon">horizon</link> and +the <link linkend="ai-ecliptic">ecliptic</link>. +</para> +<para> +However, &kstars; is more than a simple night-sky simulator. The +display provides a compelling interface to a number of tools with +which you can learn more about astronomy and the night sky. There is +a context-sensitive <link linkend="popup-menu">popup menu</link> +attached to each displayed object, which displays object-specific +information and actions. Hundreds of objects provide links in their +popup menus to informative web pages and beautiful images taken by the +Hubble Space Telescope and other observatories. +</para><para> +From an object's popup menu, you can open its <link +linkend="tool-details">Detailed Information Window</link>, where +you can examine positional data about the object, and query a huge +treasury of online databases for professional-grade astronomical data +and literature references about the object. You can even attach your +own Internet links, images and text notes, making &kstars; a graphical +front-end to your observing logs and your personal astronomical notebook. +</para> +<para> +Our <link linkend="tool-calculator">Astrocalculator</link> tool +provides direct access to many of the algorithms the program uses +behind the scenes, including coordinate converters and time +calculators. The <link linkend="tool-aavso">AAVSO Lightcurve +Generator</link> tool will download a lightcurve for any of the 6000+ +variable stars monitored by the American Association of Variable Star +Observers (AAVSO). The lightcurves are generated <quote>on the +fly</quote> by querying the AAVSO server directly, ensuring that you +have the very latest data points. +</para> +<para> +You can plan an observing session using our <link +linkend="tool-altvstime">Altitude vs. Time</link> tool, which will +plot curves representing the Altitude as a function of time for any +group of objects. If that is too much detail, we also provide a +<link linkend="tool-whatsup">What's Up Tonight?</link> tool that +summarizes the objects that you will be able to see from your location +on any given night. You can add your favorite objects to the <link +linkend="tool-observinglist">Observing List</link> tool, which +provides convenient access to common actions for a list of objects. +</para> +<para> +&kstars; also provides a <link linkend="tool-solarsys">Solar System +Viewer</link>, which shows the current configuration of the major +planets in our solar system. There is also a <link +linkend="tool-jmoons">Jupiter Moons Tool</link> which shows the positions +of Jupiter's four largest moons as a function of time. +</para> +<para> +Our primary goal is to make &kstars; an interactive educational tool for +learning about astronomy and the night sky. To this end, the &kstars; +Handbook includes the <link linkend="astroinfo">AstroInfo +Project</link>, a series of short, hyperlinked articles on astronomical +topics that can be explored with &kstars;. In addition, &kstars; +includes &DCOP; functions that allow you to <link +linkend="tool-scriptbuilder">write complex scripts</link>, making &kstars; +a powerful "demo engine" for classroom use or general illustration of +astronomical topics. +</para> +<para> +However, &kstars; is not just for students. You can control telescopes +and cameras with &kstars;, using the elegant and powerful <link +linkend="indi">INDI</link> protocol. &kstars; supports several popular +telescopes including Meade's LX200 family and Celestron GPS. Several +popular CCD cameras, webcams, and computerized focusers are also supported. +Simple slew/track commands are integrated directly into the main window's +popup menu, and the INDI Control Panel provides full access to all of +your telescope's functions. Many of these actions can also be scripted +through &kde;'s &DCOP; mechanism (our own <link +linkend="tool-scriptbuilder">Script Builder</link> tool provides a simple +point-and-click interface for these scripts). INDI's Client/Server +architecture allows for seamless control of any number of <link +linkend="indi-kstars-setup">local</link> or <link +linkend="indi-remote-control">remote</link> telescopes using a single +&kstars; session. +</para> +<para> +We are very interested in your feedback; please report bugs or +feature requests to the &kstars; development mailing list: +<email>kstars-devel@kde.org</email>. You can also use +the automated bug reporting tool, accessible from the Help menu. +</para> +</chapter> + +&quicktour; <!--A Quick Tour of KStars--> +&config; <!--Configuring KStars--> +&commands; <!--Command Reference--> +&astroinfo; <!--AstroInfo Articles--> +&tools; <!--KStars Tools--> +&dumpmode; <!--Command-line image-dump mode--> +&indi; <!-- INDI--> +&faq; <!--Questions and Answers--> +&credits; <!--Credits and License--> +&install; <!--Installation--> + +<index id='doc-index'></index> +<!-- For DocBook 4.2, remove the above line and use this instead +&documentation.index; +--> +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: +--> + + diff --git a/doc/kstars/indi.docbook b/doc/kstars/indi.docbook new file mode 100644 index 00000000..4d26b856 --- /dev/null +++ b/doc/kstars/indi.docbook @@ -0,0 +1,835 @@ +<chapter id="indi"> +<title>Astronomical Device Control with <acronym>INDI</acronym></title> +<indexterm><primary>INDI Control</primary> +<secondary>Overview</secondary> +</indexterm> + +<para>KStars provides an interface to configure and control astronomical instruments via +the <acronym><link linkend="what-is-indi">INDI</link></acronym> protocol.</para> + +<para>The <acronym>INDI</acronym> protocol supports a variety of astronomical instruments +such as CCD cameras and focusers. Currently, KStars supports the following +devices:</para> + +<table id="device-table" pgwide="1" frame="all"> +<title>Supported Telescopes</title> +<tgroup cols="3" colsep="1" rowsep="1"> +<thead> +<row> +<entry>Telescope</entry> +<entry>Device driver</entry> +<entry>Version</entry> +</row> +</thead> +<tbody> +<row> +<entry>LX200 8"-12" Classic</entry> +<entry>lx200classic</entry> +<entry>1.0</entry> +</row> +<row> +<entry>Autostar based telescopes</entry> +<entry>lx200autostar</entry> +<entry>1.0</entry> +</row> +<row> +<entry>LX200 GPS 8"-16"</entry> +<entry>lx200gps</entry> +<entry>1.0</entry> +</row> +<row> +<entry>LX200 Classic 16"</entry> +<entry>lx200_16</entry> +<entry>1.0</entry> +</row> +<row> +<entry>NexStar GPS, CGE, AS-GT</entry> +<entry>celestrongps</entry> +<entry>0.9</entry> +</row> +<row> +<entry>New GT, NexStar 5i/8i</entry> +<entry>celestrongps</entry> +<entry>0.9</entry> +</row> +<row> +<entry>Takahashi Temma</entry> +<entry>temma</entry> +<entry>0.1</entry> +</row> +<row> +<entry>Astro-Physics AP</entry> +<entry>apmount</entry> +<entry>0.1</entry> +</row> +<row> +<entry>Astro-Electronic FS-2</entry> +<entry>lx200basic</entry> +<entry>0.1</entry> +</row> +<row> +<entry>Argo Navis</entry> +<entry>lx200basic</entry> +<entry>0.1</entry> +</row> +<row> +<entry>Losmandy Gemini</entry> +<entry>lx200basic</entry> +<entry>0.1</entry> +</row> +<row> +<entry>Mel Bartels Controllers</entry> +<entry>lx200basic</entry> +<entry>0.1</entry> +</row> +<row> +<entry>Sky Commander</entry> +<entry>skycommander</entry> +<entry>0.1</entry> +</row> +</tbody> +</tgroup> +</table> +<table id="focuser-table" pgwide="1" frame="all"> +<title>Supported Focusers</title> +<tgroup cols="3" colsep="1" rowsep="1"> +<thead> +<row> +<entry>Focuser</entry> +<entry>Device driver</entry> +<entry>Version</entry> +</row> +</thead> +<tbody> +<row> +<entry>Meade LX200GPS Microfocuser</entry> +<entry>lx200gps</entry> +<entry>0.9</entry> +</row> +<row> +<entry>Meade 1206 Primary Mirror Focuser</entry> +<entry>lx200generic</entry> +<entry>0.9</entry> +</row> +<row> +<entry>JMI NGF Series</entry> +<entry>lx200generic</entry> +<entry>0.1</entry> +</row> +<row> +<entry>JMI MOTOFOCUS</entry> +<entry>lx200generic</entry> +<entry>0.1</entry> +</row> +</tbody> +</tgroup> +</table> + +<table id="ccd-table" pgwide="1" frame="all"> +<title>Supported CCDs</title> +<tgroup cols="3" colsep="1" rowsep="1"> +<thead> +<row> +<entry>CCD</entry> +<entry>Device driver</entry> +<entry>Version</entry> +</row> +</thead> +<tbody> +<row> +<entry>Finger Lakes Instruments CCDs</entry> +<entry>fliccd</entry> +<entry>1.0</entry> +</row> +<row> +<entry>Santa Barbara Instrument CCDs</entry> +<entry>sbigccd</entry> +<entry>0.1</entry> +</row> +<row> +<entry>Apogee CCDs</entry> +<entry>apogee_ppi, apogee_pci, apogee_isa, apogee_usb</entry> +<entry>0.1</entry> +</row> +</tbody> +</tgroup> +</table> + +<table id="filter-table" pgwide="1" frame="all"> + <title>Supported Filter Wheels</title> + <tgroup cols="3" colsep="1" rowsep="1"> + <thead> + <row> + <entry>Filter Wheel</entry> + <entry>Device driver</entry> + <entry>Version</entry> + </row> + </thead> + <tbody> + <row> + <entry>FLI Filter Wheels</entry> + <entry>fliwheel</entry> + <entry>0.9</entry> + </row> + </tbody> + </tgroup> + </table> + +<table id="video-table" pgwide="1" frame="all"> +<title>Supported Webcams</title> +<tgroup cols="3" colsep="1" rowsep="1"> +<thead> +<row> +<entry>Webcam</entry> +<entry>Device driver</entry> +<entry>Version</entry> +</row> +</thead> +<tbody> +<row> +<entry>Any Video4Linux compatible device</entry> +<entry>v4ldriver</entry> +<entry>1.0</entry> +</row> +<row> +<entry>Philips webcam</entry> +<entry>v4lphilips</entry> +<entry>1.0</entry> +</row> +<row> +<entry>Meade Lunar Planetary Imager</entry> +<entry>meade_lpi</entry> +<entry>0.1</entry> +</row> + +</tbody> +</tgroup> +</table> + +<sect1 id="indi-kstars-setup"> +<title>INDI Setup</title> +<indexterm><primary>INDI</primary> +<secondary>Setup</secondary> +</indexterm> +<para> +KStars can control local and remote devices seamlessly via the <link linkend="what-is-indi">INDI</link> server/client architecture. INDI devices may be run in three different modes:</para> + +<orderedlist> +<listitem><para>Local: The local mode is the most common and is used to control local device (&ie; a device attached to your machine).</para></listitem> +<listitem><para>Server: The server mode establishes an INDI server for a particular device and waits for connections from remote clients. You cannot operate server devices, you can only start and shut them down.</para></listitem> +<listitem><para>Client: The client mode is used to connect to remote INDI servers running INDI devices. You can control remote devices seamlessly like local devices.</para></listitem> +</orderedlist> + +<para>You can run local device, establish INDI servers, and connect to remote clients from the <guimenuitem>Device Manager</guimenuitem> in the <guimenu>Devices</guimenu> menu.</para> + +<para>Here is a screenshot of the <guilabel>Device Manager</guilabel> +window:</para> + +<screenshot> +<screeninfo>Running device drivers</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="devicemanager.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Start device drivers</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>You can run devices by browsing the device tree, selecting a specific device, and then clicking on the <guibutton>Run Service button</guibutton>. You can select the operation mode, either local or server as defined above.</para> + +<para>To control remove devices, refer to the <link linkend="indi-remote-control">remote device control</link> section.</para> +</sect1> + +<sect1 id="indi-telescope-setup"> +<title>Telescope Setup</title> +<indexterm><primary>INDI</primary> +<secondary>Setup</secondary> +</indexterm> + +<para>Most telescopes are equipped with <hardware>RS232</hardware> interface +for remote control. Connect the RS232 jack in your telescope to your +computer's <hardware>Serial/USB</hardware> port. Traditionally, the RS232 +connects to the serial port of your computer, but since many new laptops +abandoned the serial port in favor of <hardware>USB/FireWire</hardware> +ports, you might need to obtain a Serial to USB adaptor to use with new +laptops.</para> + +<para>After connecting your telescope to the Serial/USB port, turn your +telescope on. It is <emphasis>highly</emphasis> recommended that you +download and install the latest firmware for your telescope +controller.</para> + +<para>The telescope needs to be aligned before it can be used properly. +Align your telescope (one or two stars alignment) as illustrated in your +telescope manual.</para> + +<para>&kstars; needs to verify time and location settings before connecting to the telescope. This insures proper tracking and synchronization between the telescope and &kstars;. The following steps will enable you to connect to a device that is connected to your computer. To connect and control remote devices, please refer to <link linkend="indi-remote-control">remote device control</link> section.</para> + +<para>You can use the Telescope Setup Wizard and it will verify all the required information in the process. It can automatically scan ports for attached telescopes. You can run the wizard by selecting <guimenuitem>Telescope Setup Wizard</guimenuitem> from the <guimenu>Devices</guimenu> menu.</para> + +<para>Alternatively, you can connect to a local telescope by performing the following +steps:</para> + +<orderedlist> +<listitem><para>Set your geographical location. Open the <guilabel>Geographic...</guilabel> window by selecting +<guimenuitem>Set Geographic Location...</guimenuitem> from the +<guimenu>Settings</guimenu> menu, or by pressing the <guiicon>Globe</guiicon> icon in the toolbar, or by pressing <keycombo +action="simul">&Ctrl;<keycap>g</keycap></keycombo>.</para> +</listitem> +<listitem><para>Set your local time and date. You can change to any time or +date by selecting <guimenuitem>Set Time...</guimenuitem> from the <guimenu>Time</guimenu> menu, or by +pressing the <guiicon>time</guiicon> icon in the toolbar. The <guilabel>Set Time</guilabel> window uses a standard &kde; Date Picker widget, coupled with three spinboxes for setting the hours, minutes and seconds. If you ever need to reset the clock back to the current time, just select <guimenuitem>Set Time to Now</guimenuitem> from the <guimenu>Time</guimenu> menu.</para> +</listitem> +<listitem> +<para>Click on the <guimenu>Devices</guimenu> menu and select the +<guimenuitem>Device Manager</guimenuitem>.</para> +</listitem> +<listitem> +<para>Under the <guilabel>Device</guilabel> column, select your telescope model.</para> +</listitem> +<listitem> +<para> <mousebutton>Right</mousebutton>-click on the device and select +<guilabel>Run Service</guilabel>.</para> +</listitem> +<listitem> +<para>Click <guibutton>Ok</guibutton> to close the Device Manager +Dialog.</para> +</listitem> +</orderedlist> + +<note id="geo-time-note"> +<title>Frequent Settings</title> +<para>You do not need to set the geographic location and time every time you connect to a telescope. Only adjust the settings as needed.</para></note> + +<para>You are now ready to use the device features, &kstars; conveniently provides two interchangeable GUI interfaces for controlling telescopes:</para> + +<orderedlist> +<title>Controlling your telescope</title> +<listitem> +<para> +<guilabel>Sky map Control</guilabel>: For each device you run in the <guilabel>Device Manager</guilabel>, a corresponding entry will show up in popup menu that allows you to control the properties of the device. You can +issue commands like <command>Slew, Sync,</command> and +<command>Track</command> directly from the sky map. +</para> +<para>Here is a screenshot of the popup menu with an active LX200 Classic +device:</para> +<screenshot> +<screeninfo>Controlling devices from sky map</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="skymapdevice.png" format="PNG"/> +</imageobject> +</mediaobject> +</screenshot> +</listitem> + +<listitem> +<para> +<guilabel>INDI Control Panel</guilabel>: The panel offers the user with all the +features supported by a device. +</para> + +<para>The panel is divided into three main sections:</para> +<itemizedlist> +<listitem> +<para> +<guilabel>Device tabs</guilabel>: Each additional active device occupies a +tab in the INDI panel. Multiple devices can run simultaneously without +affecting the operation of other devices. +</para> +</listitem> +<listitem> +<para> +<guilabel>Property view</guilabel>: Properties are the key element in INDI +architecture. Each device defines a set of properties to communicate with +the client. The current position of the telescope is an example of a +property. Semantically similar properties are usually contained in logical +blocks or groupings. +</para> +</listitem> +<listitem> +<para> +<guilabel>Log viewers</guilabel>: Devices report their status and acknowledge commands by sending INDI messages. Each device has its own log view, and all devices share one generic log viewer. A device usually sends messages to its device driver only, but a device is permitted to send a generic message when appropriate. +</para> +</listitem> +</itemizedlist> +<screenshot> +<screeninfo>INDI Control Panel</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="indicontrolpanel.png" format="PNG"/> +</imageobject> +</mediaobject> +</screenshot> +</listitem> +</orderedlist> + +<para>You are not restricted on using one interface over another as they can be both used simultaneously. Actions from the <guilabel>Sky map</guilabel> are automatically reflected in the <guilabel>INDI Control Panel</guilabel> +and vice versa.</para> + +<para>To connect to your telescope, you can either select <guimenuitem>Connect</guimenuitem> from your device popup menu or +alternatively, you can press <guibutton>Connect</guibutton> under your device tab in the <guilabel>INDI Control Panel</guilabel>.</para> + +<important><para>By default, KStars will try to connect to the <constant>/dev/ttyS0</constant> +port. To change the connection port, select <guilabel>INDI Control Panel</guilabel> from the <guimenu>Devices</guimenu> menu and change the port under your device tab.</para></important> + +<para>&kstars; automatically updates the telescope's longitude, latitude, and +time based on current settings in &kstars;. You can enable/disable these +updates from <guimenuitem>Configure INDI</guimenuitem> dialog under the +<guimenu>Devices</guimenu> menu. +</para> + +<para>If &kstars; communicates successfully with the telescope, it will retrieve the current <abbrev>RA</abbrev> and <abbrev>DEC</abbrev> from the telescope and will display a crosshair on the sky map indicating the telescope position.</para> + +<note id="indi-sync"> +<title>Synchronizing your telescope</title> +<para>If you aligned your telescope and the last alignment star was, for example, Vega, then the crosshair should be centered around Vega. If the crosshair was off target, then you can <mousebutton>right</mousebutton>-click Vega from the sky map and select +<command>Sync</command> from your telescope menu. This action will instruct the telescope to synchronize its internal coordinates to match those of Vega, and the telescope's crosshair should now be centered around Vega. +</para> +</note> + +<para>That is it: your telescope is ready to explore the heavens.</para> + +<warning> +<title>WARNING</title> +<para>Never use the telescope to look at the sun. Looking at the sun might cause irreversible damage to your eyes and as well as your equipment.</para> +</warning> +</sect1> + +<sect1 id="indi-other-setup"> +<title>CCD and Video-Capture Setup</title> +<indexterm><primary>CCD Video Control</primary> +<secondary>Setup</secondary> +</indexterm> + +<para>KStars supports the following imaging devices:</para> +<itemizedlist> + <listitem><para>Finger Lakes instruments CCDs</para></listitem> + <listitem><para>Apogee CCDs: Parallel, ISA, PCI, and USB modes are supported. You need to install <ulink url="http://indi.sf.net/apogee_kernel.tar.gz">Apogee kernel drivers</ulink> for your specific mode (for USB mode, you only need libusb).</para></listitem> + <listitem><para><ulink url="http://www.exploits.org/v4l/">Video4Linux</ulink> compatible devices. Philips webcam extended features are supported as well.</para></listitem> +</itemizedlist> + +<para>You can run CCD and Video Capture devices from the <guimenuitem>Device Manager</guimenuitem> in the <guimenu>Devices</guimenu> menu. Like all INDI devices, some of the device controls will be accessible from the skymap. The device can be controlled fully from the <guimenuitem>INDI Control Panel.</guimenuitem></para> + +<para>The standard format for image capture is FITS. Once an image is captured and downloaded, it will be automatically displayed in the KStars <link linkend="tool-fitsviewer">FITS Viewer</link>. To capture a sequence of images, use the <guimenuitem>Capture Image Sequence</guimenuitem> tool from the <guimenu>Devices</guimenu> menu. This tool is inactive until you establish a connection to an image device.</para> + +<important> +<para>The FLICCD driver requires root privileges in order to operate properly. Note that running the driver as root is considered a security risk</para> +</important> +</sect1> + +<sect1 id="indi-capture"> +<title>Capture Image Sequence</title> +<indexterm><primary>Capture</primary> +<secondary>Image</secondary> +</indexterm> + +<para>The Capture Image Sequence tool can be used to aquire images from cameras and CCDs in interactive and batch modes. Furthermore, you can select which filter, if any, you want to use for your images. The capture tool remains disabled until you establish a connection to an imaging device.</para> + +<screenshot> +<screeninfo>Capture Image Sequence</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="indicapture.png" format="PNG"/> +</imageobject> +</mediaobject> +</screenshot> + +<para>The above screenshot depicts a sample capture session. The tool provides the following options:</para> +<itemizedlist> + <listitem><para>Camera/CCD</para> + <itemizedlist> + <listitem><para><option>Device:</option> The desired imaging device.</para></listitem> + <listitem><para><option>Prefix:</option> The image prefix which will be prepended to each captured filename.</para></listitem> + <listitem><para><option>Exposure:</option> The number of seconds to expose each frame.</para></listitem> + <listitem><para><option>Count:</option> The number of images to aquire.</para></listitem> + <listitem><para><option>Delay:</option> The delay in seconds between consecutive images.</para></listitem> + <listitem><para><option>ISO 8601 time stamp:</option> Append ISO 8601 time stamp to the filename. (e.g. image_01_20050427T09:48:05).</para></listitem> + </itemizedlist> + </listitem> + <listitem><para>Filter</para> + <itemizedlist> + <listitem><para><option>Device:</option> The desired filter device.</para></listitem> + <listitem><para><option>Filter:</option> The desired filter slot. You can assign color values to slot numbers using the <link linkend="indi-configure">Configure INDI</link> window (e.g. Slot #1 = Red, Slot #2 = Blue..etc).</para></listitem> + </itemizedlist> + </listitem> +</itemizedlist> + +<para>After you fill in the desired options, you can begin the capture procedure by pressing the <guibutton>Start</guibutton> button. You may cancel at any time using the <guibutton>Stop</guibutton> button. All captured images will be saved to the default FITS directory which can be specified in the <link linkend="indi-configure">Configure INDI</link> window.</para> + +<para>If you have more complex capturing requirements and conditions to fulfil, it is recommended to create a script to meet your specific needs using the <link linkend="tool-scriptbuilder">Script Builder</link> tool in the <guimenu>Tools</guimenu> menu.</para> +</sect1> + +<sect1 id="indi-configure"> +<title>Configure INDI</title> +<indexterm><primary>Configure</primary> +<secondary>INDI</secondary> +</indexterm> + +<para>The Configure INDI window allows you to modify <emphasis>Client side</emphasis> INDI specific options. The window is divided into four main categories: General, Automatic device updates, Display, and Filter Wheel:</para> + + <itemizedlist> + <listitem><para>General</para> + <itemizedlist> + <listitem><para><option>Default FITS directory:</option> Specify the directory where all captured FITS images will be saved to. If no directory is specified, images will be stored in $HOME.</para></listitem> + <listitem><para><option>Automatic Display of FITS upon capture:</option> When checked, KStars will display captured FITS in KStars <link linkend="tool-fitsviewer">FITS Viewer</link> tool. If you use the <link linkend="indi-capture">Capture Image Sequence</link> tool, all captured images will be saved to disk regardless of this option.</para></listitem> + <listitem><para><option>Telescope port:</option> The default telescope port. When you connect to a local or remote telescope service, KStars will automatically fill the telescope's device port with the specified default port.</para></listitem> + <listitem><para><option>Video port:</option> The default video port. When you connect to a local or remote video service, KStars will automatically fill the webcam's device port with the specified default port.</para></listitem> + </itemizedlist> + </listitem> + <listitem><para>Automatic device updates</para> + <itemizedlist> + <listitem><para><option>Time:</option> Update the telescope's date and time, if supported, upon connection.</para></listitem> + <listitem><para><option>Geographic location:</option> Update the telescope's geographical location information (current longitude and latitude), if supported, upon connection.</para></listitem> + </itemizedlist> + </listitem> + <listitem><para>Display</para> + <itemizedlist> + <listitem><para><option>Device target crosshair:</option> When checked, KStars displays the telescope's target crosshair on the sky map. The crosshair is displayed upon a successful connection to the telescope and its location is updated periodically. The telescope's name is displayed next to the crosshair. KStars displays one crosshair per each connected telescope. To change the color of the telescope's crosshair, open the <link linkend="viewops">Configure KStars</link> window. Select the <guilabel>Colors</guilabel> tab, and then change the color of the <emphasis>Target Indicator</emphasis> item to the desired color.</para></listitem> + <listitem><para><option>INDI messages in status bar:</option> When checked, KStars displays INDI status messages in the KStars status bar.</para></listitem> + </itemizedlist> + </listitem> + <listitem><para>Filter Wheel: Assign color codes to the filter wheel slots (e.g. Slot #0 Red, Slot #1 Blue..etc). You can assign color codes for up to 10 filter slots (0 to 9). To assign a color code, select a slot number from the drop down combo box, and then type the corresponding color code in the edit field. Repeat the process for all desired slots and then press OK.</para> + </listitem> + </itemizedlist> + +</sect1> + +<sect1 id="indi-concepts"> +<title>INDI Concepts</title> +<indexterm><primary>Telescope Control</primary> +<secondary>Concepts</secondary> +</indexterm> + +<para> +The main key concept in INDI is that devices have the ability to describe themselves. This is accomplished by using XML to describe a generic hierarchy that can represent both canonical and non-canonical devices. In INDI, all <emphasis>devices</emphasis> may contain one or more <emphasis>properties</emphasis>. Any <emphasis>property</emphasis> may contain one or more <emphasis>elements</emphasis>. There are four types of INDI properties:</para> +<itemizedlist> +<listitem><para>Text property.</para></listitem> +<listitem><para>Number property.</para></listitem> +<listitem><para>Switch property (Represented in GUI by buttons and checkboxes).</para></listitem> +<listitem><para>Light property (Represented in GUI by colored LEDs).</para></listitem> +</itemizedlist> + +<para>For example, all INDI devices share the CONNECTION standard switch <emphasis>property</emphasis>. The CONNECTION property has two elements: CONNECT and DISCONNECT switches. KStars parses the generic XML description of properties and builds a GUI representation suitable for direct human interaction.</para> + +<para>The INDI control panel offers many device properties not accessible from the sky map. The properties offered differ from one device to another. Nevertheless, all properties share common features that constrains how they are displayed and used:</para> + +<itemizedlist> +<listitem> +<para> +Permission: All properties can either be read-only, write-only, or read and +write enabled. An example of a read-write property is the telescope's Right +Ascension. You can enter a new Right Ascension and the telescope, based on +current settings, will either slew or sync to the new input. Furthermore, +when the telescope slews, its Right Ascension gets updated and sent back to +the client.</para> +</listitem> +<listitem> +<para>State: Prefixed to each property is a state indicator (round LED). +Each property has a state and an associated color code:</para> +<table frame="top"><title>INDI State color code</title> +<tgroup cols="3" colsep="1" rowsep="1"> +<thead> +<row> +<entry>State</entry> +<entry>Color</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>Idle</entry> +<entry>Gray</entry> +<entry>Device is performing no action with respect to this property</entry> +</row> +<row> +<entry>Ok</entry> +<entry>Green</entry> +<entry>Last operation performed on this property was successful and +active</entry> +</row> +<row> +<entry>Busy</entry> +<entry>Yellow</entry> +<entry>The property is performing an action</entry> +</row> +<row> +<entry>Alert</entry> +<entry>Red</entry> +<entry>The property is in critical condition and needs immediate +attention</entry> + </row> + </tbody> +</tgroup> +</table> + +<para>The device driver updates the property state in real-time when +necessary. For example, if the telescope is in the process of slewing to a +target, then the RA/DEC properties will be signaled as +<guilabel>Busy</guilabel>. When the slew process is completed successfully, +the properties will be signaled as +<guilabel>Ok</guilabel>.</para> +</listitem> +<listitem> +<para> +Context: Numerical properties can accept and process numbers in two formats: +decimal and sexagesimal. The sexagesimal format is convenient when expressing +time or equatorial/geographical coordinates. You can use any format at your +convenience. For example, all the following numbers are equal:</para> +<itemizedlist> +<listitem><para>-156.40</para></listitem> +<listitem><para>-156:24:00</para></listitem> +<listitem><para>-156:24</para></listitem> +</itemizedlist> +</listitem> +<listitem> +<para> +Time: The standard time for all INDI-related communications is Universal Time UTC specified as YYYY-MM-DDTHH:MM:SS in accord with ISO 8601. &kstars; communicates the correct UTC time with device drivers automatically. You can enable/disable automatic time updates from the <guimenuitem>Configure INDI</guimenuitem> dialog under the <guimenu>Devices</guimenu> menu. +</para> +</listitem> +</itemizedlist> +</sect1> + +<sect1 id="indi-remote-control"> +<title>Remote Device Control</title> +<indexterm><primary>Telescope Control</primary> +<secondary>Remote Devices</secondary> +</indexterm> + +<para>KStars provides a simple yet powerful layer for remote device control. +A detailed description of the layer is described in the INDI <ulink +url="http://www.clearskyinstitute.com/INDI/INDI.pdf">white +paper</ulink>.</para> + +<para>You need to configure both the server and client machines for remote +control:</para> + +<orderedlist> +<listitem> +<para>Server: To prepare a device for remote control, follow the same steps in the <link linkend="indi-kstars-setup">local/server</link> setup. When you start a device service in the <guimenu>Device Manager</guimenu>, a port number is displayed under the <guilabel>Listening port</guilabel> column. In addition to the port number, you also need the hostname or IP address of your server. +</para> + +</listitem> +<listitem> +<para>Client: Select the <guimenuitem>Device Manager</guimenuitem> from the <guimenu>Device</guimenu> menu and click on the <guilabel>Client</guilabel> tab. You can add, modify, or delete hosts under the <guilabel>Client</guilabel> tab. Add a host by clicking on the <guibutton>Add</guibutton> button. Enter the hostname/IP address of the server in the <guilabel>Host</guilabel> field, and enter the port number obtained from the <emphasis>server</emphasis> machine in step 1. +</para> +</listitem> +</orderedlist> + +<screenshot> +<screeninfo>INDI Client</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="indiclient.png" format="PNG"/> +</imageobject> +</mediaobject> +</screenshot> + +<para>After you add a host, right click on the host to +<guimenuitem>Connect</guimenuitem> or <guimenuitem>Disconnect</guimenuitem>. +If a connection is established, you can control the telescope from the +<guilabel>Sky map</guilabel> or <guilabel>INDI Control Panel</guilabel> +exactly as described in the <link linkend="indi-kstars-setup">local/server</link> section. It is as easy at that. +</para> + +<sect2 id="indi-commandline"> +<title>Running an INDI server from the command line</title> +<para>While &kstars; allows you to easily deploy an INDI server; you can launch an INDI server from the command line. +</para> + +<para> +Since INDI is an independent backend component, you can run an INDI server on a host without KStars. INDI can be compiled separately to run on remote hosts. Furthermore, device drivers log messages to <constant>stderr</constant> and that can be helpful in a debugging situation. The syntax for INDI server is +as following:</para> + +<para>$ <command>indiserver</command> [options] [<filename>driver</filename> +...]</para> + +<para>Options:</para> +<para> -p p : alternate IP port, default 7624</para> +<para> -r n : max restart attempts, default 2</para> +<para> -v : more verbose to stderr</para> + +<para>For example, if you want to start an INDI server running an LX200 GPS +driver and listening to connections on port 8000, you would run the +following command:</para> + +<para>$ <command>indiserver</command> -p 8000 <filename>lx200gps</filename></para> +</sect2> + +<sect2 id="indi-secure-remote"> +<title>Secure Remote Operation</title> + +<para>Suppose we want to run an indiserver with INDI drivers on a remote host, +<constant>remote_host</constant>, and connect them to &kstars; running on the local machine.</para> + +<para>From the local machine log onto the remote host, <constant>remote_host</constant>, by typing:</para> + +<para>$ <command>ssh</command> -L <varname>local_port</varname>:<constant>remote_host</constant>:<varname>remote_port</varname></para> + +<para>This binds the <varname>local_port</varname> on the local machine to the <varname>remote_port</varname> on the <constant>remote_host</constant>. After logging in, run indiserver on the remote host:</para> + +<para>$ <command>indiserver</command> -p <varname>remote_port</varname> [<filename>driver</filename>...]</para> + +<para>Back on the local machine, start &kstars; then open the <guimenuitem>Device Manager</guimenuitem> and add a host under the <guilabel>Client</guilabel> tab. The host should be the local host (usually 127.0.0.1) and the port number should be the <varname>local_port</varname> used in the steps above. <mousebutton>Right</mousebutton>-click on the host and select <guimenuitem>Connect</guimenuitem> from the popup menu. &kstars; will connect to the remote INDI server securely. The host information will be saved for future sessions.</para> +</sect2> +</sect1> + +<sect1 id="indi-faq"> +<title>INDI Frequently Asked Questions</title> +<indexterm><primary>Telescope Control</primary> +<secondary><acronym>FAQ</acronym></secondary> +</indexterm> + +<qandaset defaultlabel="qanda"> +<qandaentry> +<question id="what-is-indi"> +<para>What is INDI?</para> +</question> +<answer> +<para> <acronym>INDI</acronym> is the <ulink url="http://indi.sourceforge.net"> Instrument-Neutral-Distributed-Interface</ulink> control protocol developed by <author><firstname>Elwood</firstname><surname>C. +Downey</surname></author> of <ulink url="http://www.clearskyinstitute.com/">ClearSky Institute</ulink>. &kstars; employs device drivers that are compatible with the INDI protocol. INDI has many advantages including loose coupling between hardware devices and +software drivers. Clients that use the device drivers (like &kstars;) are completely unaware of the device capabilities. In run time, &kstars; communicates with the device drivers and builds a completely dynamical GUI based on services provided by the device. Therefore, new device drivers can be written or updated and KStars can take full advantage of them without any changes on the client side.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +Do you plan to support more devices? +</para> +</question> +<answer> +<para> +Yes. We plan to support major CCD cameras and focusers and extend support +for more telescopes. If you would like INDI to support a particular device, +please send an email to <email>indi-devel@lists.sourceforge.net</email> +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +What operations does KStars provide to control the telescope? +</para> +</question> +<answer> +<para> +It depends on the particular telescope you're running, but the minimum three operations are <command>Slew</command>, <command>Track</command>, and <command>Sync</command>, which you can issue directly from the sky map. Your telescope must be aligned for those operations to perform correctly. Some telescopes offer you more operations like site management, slew modes, focusing, parking, and more. You can access the telescopes extended features from the INDI Control Panel in the Devices Menu. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +What's the difference between <command>Slew</command>, <command>Track</command>, and <command>Sync</command> exactly? +</para> +</question> +<answer> +<para> +The command <command>Slew</command> orders the telescope to move to a particular target, and once the telescope reaches its target, the telescope keeps tracking that target at a <emphasis>sidereal</emphasis> rate (i.e. the rate at which stars move across the sky). This works well for stars, Messier objects, and about everything outside our solar system. But solar system objects travel differently across the sky and so the telescope must <command>Track</command> the objects as they move. +</para> +<para> +Therefore, you need to issue a track command if you want to track an object with non-sidereal motion. On the other hand, <command>Sync</command> is used to synchronize the telescope's internal coordinates with that of an object you select. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +Can I control my telescope remotely? +</para> +</question> +<answer> +<para> +Yes. You can start an INDI server on the machine connected to your telescope and the server will listen to requests from &kstars; clients. Once you're connected, you can control your telescope directly from the sky map. This procedure is described in detail in the <link linkend="indi-remote-control">Remote device control</link> section. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para> +When I try to <guibutton>Connect</guibutton>, &kstars; reports that the +telescope is not connected to the serial/USB port. What can I do? +</para> +</question> +<answer> +<para>This message is triggered when &kstars; cannot communicate with the telescope. Here are few things you can do:</para> + + <orderedlist> + <listitem> +<para>Check that you have both reading and writing permission for the port you are trying to connect to.</para> + </listitem> + <listitem> +<para>Check the connection cable, make sure it is in good condition and test it with other applications.</para> + </listitem> + <listitem> +<para>Check your telescope power, make sure the power is on and that the telescope is getting enough power.</para> + </listitem> + <listitem> +<para>Set the correct port in the <guilabel>INDI Control Panel</guilabel> +under the <guimenu>Devices</guimenu> menu. The default device is +<constant>/dev/ttyS0</constant></para> + </listitem> + <listitem> + <para>Restart &kstars; and retry again.</para> + </listitem> + </orderedlist> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>&kstars; reports that the telescope is online and ready, but I cannot find the telescope's crosshair, where is it?</para> +</question> +<answer> +<para>&kstars; retrieves the telescopes RA and DEC coordinates upon connection. If your alignment was performed correctly, then you should see the crosshair around your target in the Sky Map. However, the RA and DEC coordinates provided by the telescope may be incorrect (even below the horizon) and you need to <link linkend="indi-sync">Sync</link> your telescope to your current target. You can use the right-click menu to center and track the telescope crosshair in the sky map.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>The telescope is moving erratically or not moving at all. What can I do?</para> +</question> +<answer> +<para>This behavior is mostly due to incorrect settings, please verify the following check list:</para> +<orderedlist> +<listitem> +<para>Is the telescope aligned?</para> +</listitem> +<listitem> +<para>Is the telescope alignment mode correct? Use <guilabel>INDI Control Panel</guilabel> to check and change these settings (<constant>Alt/Az,Polar, Land</constant>).</para> +</listitem> +<listitem> +<para>Are the telescope's time and date settings correct?</para> +</listitem> +<listitem> +<para>Are the telescope's longitude and latitude settings correct?</para> +</listitem> +<listitem> +<para>Is the telescope's UTC offset correct?</para> +</listitem> +<listitem> +<para>Are the telescope's RA and DEC axis locked firmly?</para> +</listitem> +<listitem> +<para>Is the telescope's N/S switch (when applicable) setup correctly for your hemisphere?</para> +</listitem> +<listitem> +<para>Is the cable between the telescope and computer in good condition?</para> +</listitem> +</orderedlist> + +<para>If you think all settings are correct but the telescope still moves erratically or not at all, then please send a report to +<email>kstars-devel@kde.org</email></para> +</answer> +</qandaentry> +</qandaset> +</sect1> +</chapter> + diff --git a/doc/kstars/indicapture.png b/doc/kstars/indicapture.png Binary files differnew file mode 100644 index 00000000..f99192dc --- /dev/null +++ b/doc/kstars/indicapture.png diff --git a/doc/kstars/indiclient.png b/doc/kstars/indiclient.png Binary files differnew file mode 100644 index 00000000..1cb15a93 --- /dev/null +++ b/doc/kstars/indiclient.png diff --git a/doc/kstars/indicontrolpanel.png b/doc/kstars/indicontrolpanel.png Binary files differnew file mode 100644 index 00000000..b206c047 --- /dev/null +++ b/doc/kstars/indicontrolpanel.png diff --git a/doc/kstars/indiscript.png b/doc/kstars/indiscript.png Binary files differnew file mode 100644 index 00000000..41e21d2c --- /dev/null +++ b/doc/kstars/indiscript.png diff --git a/doc/kstars/install.docbook b/doc/kstars/install.docbook new file mode 100644 index 00000000..a45cfa76 --- /dev/null +++ b/doc/kstars/install.docbook @@ -0,0 +1,105 @@ +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kstars"> +<title>How to obtain &kstars;</title> +<para> +&kstars; is distributed with &kde; as part of the kdeedu "Edutainment" +module. +</para> +<para> +We also occasionally make an independent release. These independent +releases will be available as a gzipped tar archive from the following +website: +<ulink + url="http://prdownloads.sourceforge.net/kstars/">http://prdownloads.sourceforge.net/kstars/</ulink>. +</para> +<para> +Independent releases are announced through the +<email>kstars-announce@lists.sourceforge.net</email> mailing list. +Releases are also posted to <ulink url="http://edu.kde.org/kstars">the +&kstars; home page</ulink>, +<ulink url="http://www.kde-apps.org/content/show.php?content=9862">kde-apps.org</ulink>, and +<ulink url="http://freshmeat.net/projects/kstars">freshmeat.net</ulink>. +</para> +<para> +&kstars; is been packaged by many Linux/BSD distributions, including Redhat, Suse, +and Mandrake. Some distributions package &kstars; as a separate application, some +just provide a kdeedu package, which includes &kstars;. +</para><para> +If you would like the latest CVS development version of &kstars;, please +follow <ulink url="http://edu.kde.org/kstars/cvs.html">these instructions</ulink>. +</para> +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> +<para> +In order to successfully run &kstars;, you need &kde; >=3.2 and +&Qt;>=3.2. +</para> +<para> +To compile &kstars;, you will also have to have the following packages +installed: +<itemizedlist> +<listitem><para>kdelibs-devel</para></listitem> +<listitem><para>qt-devel</para></listitem> +<listitem><para>zlib-devel</para></listitem> +<listitem><para>fam-devel</para></listitem> +<listitem><para>png-devel</para></listitem> +<listitem><para>jpeg-devel</para></listitem> +<listitem><para>autoconf (>=2.5)</para></listitem> +</itemizedlist></para> + +<para> +On my system, &kstars; uses about 60 MB of system memory with the +default settings. Most of this usage is due to the loaded object +databases. You can dramatically reduce the memory footprint by +reducing the faint limit for stars in the Configuration Window, or +eliminating catalogs of objects (NGC, IC, comets, asteroids, &etc;). +If &kstars; is idling, it uses very little <acronym>CPU</acronym>; +but it will use as much as you have got when panning or zooming. +</para> +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +<para> +In order to compile and install &kstars; on your system, type the +following in the base folder of the unpacked &kstars; distribution: +<screen width="40"> +<prompt>%</prompt> <userinput>./configure --prefix=$KDEDIR</userinput> +<prompt>%</prompt> <userinput>make</userinput> +<prompt>%</prompt> <userinput>make install</userinput> +</screen> +</para><para> +Please do not forget the prefix argument to configure. If your <envar>KDEDIR</envar> +variable is not set, set prefix to whatever folder &kde; is installed in: this is +usually either <filename class="directory">/usr</filename>, +<filename class="directory">/opt/kde</filename>, or +<filename class="directory">/opt/kde3</filename>. +Also, make sure you do the +last step as <systemitem class="username">root</systemitem>. +</para><para> +&kstars; uses <command>autoconf</command> and <command>automake</command>, +so you should not have trouble compiling it. Should you run into problems +please report them to the &kstars; mailing list +<email>kstars-devel@kde.org</email>. +</para> +</sect1> + +<sect1 id="configuration"> +<title>Configuration</title> +<para> +At this point, there are no special configuration options or +requirements. If &kstars; complains that there are missing data files, +become <systemitem class="username">root</systemitem> and manually copy +all files in <filename class="directory">kstars/data/</filename> to +<filename class="directory">$(KDEDIR)/apps/kstars/</filename> (If you +do not have <systemitem class="username">root</systemitem> privileges, +copy them to +<filename class="directory">~/.kde/share/apps/kstars/.</filename>) +</para> +</sect1> +</appendix> diff --git a/doc/kstars/jmoons.docbook b/doc/kstars/jmoons.docbook new file mode 100644 index 00000000..40a7d7b7 --- /dev/null +++ b/doc/kstars/jmoons.docbook @@ -0,0 +1,38 @@ +<sect1 id="tool-jmoons"> +<title>Jupiter Moons Tool</title> +<indexterm><primary>Tools</primary> +<secondary>Jupiter Moons Tool</secondary> +</indexterm> + +<screenshot> +<screeninfo> +The Jupiter Moons Tool +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="jmoons.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Jupiter Moons Tool</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This tool displays the positions of Jupiter's four largest +moons (Io, Europa, Ganymede, and Callisto) relative to Jupiter, +as a function of time. Time is plotted vertically; the units are days +and <quote>time=0.0</quote> corresponds to the current simulation time. +The horizontal axis displays the angular offset from Jupiter's position, +in arcminutes. The offset is measured along the direction of Jupiter's +equator. Each moon's position as a function of time traces a sinusoidal +path in the plot, as the moon orbits around Jupiter. Each track is +assigned a different color to distinguish it from the others; the name +labels at the top of the window indicate the color used by each moon. +</para><para> +The plot can be manipulated with the keyboard. The time axis can be +expanded or compressed using the <keycap>+</keycap> and +<keycap>-</keycap> keys. The time displayed at the center of the window +can be changed with the <keycap>[</keycap> and <keycap>]</keycap> keys. +</para> +</sect1> diff --git a/doc/kstars/jmoons.png b/doc/kstars/jmoons.png Binary files differnew file mode 100644 index 00000000..235ae39f --- /dev/null +++ b/doc/kstars/jmoons.png diff --git a/doc/kstars/julianday.docbook b/doc/kstars/julianday.docbook new file mode 100644 index 00000000..03ae53c3 --- /dev/null +++ b/doc/kstars/julianday.docbook @@ -0,0 +1,58 @@ +<sect1 id="ai-julianday"> +<sect1info> +<author> +<firstname>John</firstname> +<surname>Cirillo</surname> +</author> +</sect1info> +<title>Julian Day</title> +<indexterm><primary>Julian Day</primary> +</indexterm> +<para> +Julian Days are a way of reckoning the current date by a simple count of +the number of days that have passed since some remote, arbitrary date. This +number of days is called the <firstterm>Julian Day</firstterm>, +abbreviated as <abbrev>JD</abbrev>. The starting point, <abbrev>JD=0</abbrev>, +is January 1, 4713 BC (or -4712 January 1, since there was no year '0'). Julian +Days are very useful because they make it easy to determine the number of days +between two events by simply subtracting their Julian Day numbers. +Such a calculation is difficult for the standard (Gregorian) calendar, because +days are grouped into months, which contain a variable number of days, and +there is the added complication of <link linkend="ai-leapyear">Leap +Years</link>. +</para><para> +Converting from the standard (Gregorian) calendar to Julian Days and vice versa +is best left to a special program written to do this, such as the &kstars; +<link linkend="tool-calculator">Astrocalculator</link>. However, for those +interested, here is a simple example of a Gregorian to Julian day converter: +</para><para> +<abbrev>JD</abbrev> = <abbrev>D</abbrev> - 32075 + 1461*( <abbrev>Y</abbrev> + +4800 + ( <abbrev>M</abbrev> - 14 ) / 12 ) / 4 + 367*( <abbrev>M</abbrev> - 2 - +( <abbrev>M</abbrev> - 14 ) / 12 * 12 ) / 12 - 3*( ( <abbrev>Y</abbrev> + 4900 + +( <abbrev>M</abbrev> - 14 ) / 12 ) / 100 ) / 4 +</para><para> +where <abbrev>D</abbrev> is the day (1-31), <abbrev>M</abbrev> is the Month +(1-12), and <abbrev>Y</abbrev> is the year (1801-2099). Note that this formula +only works for dates between 1801 and 2099. More remote dates require a more +complicated transformation. +</para><para> +An example Julian Day is: <abbrev>JD</abbrev> 2440588, which corresponds to +1 Jan, 1970. +</para><para> +Julian Days can also be used to tell time; the time of day is expressed as a +fraction of a full day, with 12:00 noon (not midnight) as the zero point. So, +3:00 pm on 1 Jan 1970 is <abbrev>JD</abbrev> 2440588.125 (since 3:00 pm is 3 +hours since noon, and 3/24 = 0.125 day). Note that the Julian Day is always +determined from <link linkend="ai-utime">Universal Time</link>, not Local Time. +</para><para> +Astronomers use certain Julian Day values as important reference points, called +<firstterm>Epochs</firstterm>. One widely-used epoch is called J2000; it is the +Julian Day for 1 Jan, 2000 at 12:00 noon = <abbrev>JD</abbrev> 2451545.0. +</para><para> +Much more information on Julian Days is available on the internet. A good +starting point is the <ulink +url="http://aa.usno.navy.mil/faq/docs/JD_Formula.html">U.S. Naval +Observatory</ulink>. If that site is not available when you read this, try +searching for <quote>Julian Day</quote> with your favorite search engine. +</para> +</sect1> diff --git a/doc/kstars/kepler2nd.png b/doc/kstars/kepler2nd.png Binary files differnew file mode 100644 index 00000000..2734fcf9 --- /dev/null +++ b/doc/kstars/kepler2nd.png diff --git a/doc/kstars/kepler3d.png b/doc/kstars/kepler3d.png Binary files differnew file mode 100644 index 00000000..aaab7107 --- /dev/null +++ b/doc/kstars/kepler3d.png diff --git a/doc/kstars/lambda_ex.png b/doc/kstars/lambda_ex.png Binary files differnew file mode 100644 index 00000000..1a95ba9c --- /dev/null +++ b/doc/kstars/lambda_ex.png diff --git a/doc/kstars/lambda_max.png b/doc/kstars/lambda_max.png Binary files differnew file mode 100644 index 00000000..81ede73b --- /dev/null +++ b/doc/kstars/lambda_max.png diff --git a/doc/kstars/leapyear.docbook b/doc/kstars/leapyear.docbook new file mode 100644 index 00000000..899115ae --- /dev/null +++ b/doc/kstars/leapyear.docbook @@ -0,0 +1,65 @@ +<sect1 id="ai-leapyear"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>Leap Years</title> +<indexterm><primary>Leap Years</primary> +</indexterm> +<para> +The Earth has two major components of motion. First, it spins on its rotational +axis; a full spin rotation takes one <firstterm>Day</firstterm> to complete. +Second, it orbits around the Sun; a full orbital rotation takes one +<firstterm>Year</firstterm> to complete. +</para><para> +There are normally 365 days in one <emphasis>calendar</emphasis> year, but it +turns out that a <emphasis>true</emphasis> year (&ie;, a full orbit of the Earth +around the Sun; also called a <firstterm>tropical year</firstterm>) is a little +bit longer than 365 days. In other words, in the time it takes the Earth to +complete one orbital circuit, it completes 365.24219 spin rotations. Do not be +too surprised by this; there is no reason to expect the spin and orbital motions +of the Earth to be synchronized in any way. However, it does make marking +calendar time a bit awkward.... +</para><para> +What would happen if we simply ignored the extra 0.24219 rotation at the end of +the year, and simply defined a calendar year to always be 365.0 days long? The +calendar is basically a charting of the Earth's progress around the Sun. If we +ignore the extra bit at the end of each year, then with every passing year, the +calendar date lags a little more behind the true position of Earth around the +Sun. In just a few decades, the dates of the solstices and equinoxes will have +drifted noticeably. +</para><para> +In fact, it used to be that all years <emphasis>were</emphasis> defined to have +365.0 days, and the calendar <quote>drifted</quote> away from the true seasons +as a result. In the year 46 <abbrev>BCE</abbrev>, Julius Caeser established the +<firstterm>Julian Calendar</firstterm>, which implemented the world's first +<firstterm>leap years</firstterm>: He decreed that every 4th year would be 366 +days long, so that a year was 365.25 days long, on average. This basically +solved the calendar drift problem. +</para><para> +However, the problem wasn't completely solved by the Julian calendar, because a +tropical year isn't 365.25 days long; it's 365.24219 days long. You still have +a calendar drift problem, it just takes many centuries to become +noticeable. And so, in 1582, Pope Gregory XIII instituted the +<firstterm>Gregorian calendar</firstterm>, which was largely the same as the +Julian Calendar, with one more trick added for leap years: even Century years +(those ending with the digits <quote>00</quote>) are only leap years if they are divisible by +400. So, the years 1700, 1800, and 1900 were not leap years (though they would +have been under the Julian Calendar), whereas the year 2000 +<emphasis>was</emphasis> a leap year. This change makes the average length of a +year 365.2425 days. So, there is still a tiny calendar drift, but it amounts to +an error of only 3 days in 10,000 years. The Gregorian calendar is still used as +a standard calendar throughout most of the world. +</para> +<note> +<para> +Fun Trivia: When Pope Gregory instituted the Gregorian Calendar, the Julian +Calendar had been followed for over 1500 years, and so the calendar date had +already drifted by over a week. Pope Gregory re-synchronized the calendar by +simply <emphasis>eliminating</emphasis> 10 days: in 1582, the day after October +4th was October 15th! +</para> +</note> +</sect1> diff --git a/doc/kstars/lightcurve.png b/doc/kstars/lightcurve.png Binary files differnew file mode 100644 index 00000000..bb02d1a4 --- /dev/null +++ b/doc/kstars/lightcurve.png diff --git a/doc/kstars/lightcurves.docbook b/doc/kstars/lightcurves.docbook new file mode 100644 index 00000000..344ecc82 --- /dev/null +++ b/doc/kstars/lightcurves.docbook @@ -0,0 +1,176 @@ +<sect1 id="tool-aavso"> + +<sect1info> +<author> +<firstname>Aaron</firstname> +<surname>Price</surname> +<affiliation><address> +<email>aavso@aavso.org</email> +</address></affiliation> +</author> +</sect1info> + +<title>AAVSO Light Curves</title> +<indexterm><primary>Tools</primary> +<secondary>AAVSO Lightcurve Generator</secondary> +</indexterm> + +<screenshot> +<screeninfo> +The AAVSO Lightcurves Tool +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="aavso.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>AAVSO Lightcurves</phrase> + </textobject> +</mediaobject> +</screenshot> + +<sect2 id="aavso-intro"> +<title>Introduction</title> +<para> +&kstars; can display light curves for variable stars from the observing +program of the <ulink url="http://www.aavso.org">American Association +of Variable Star Observers</ulink> (<abbrev>AAVSO</abbrev>). This +program monitors over 6,000 variable stars and consists of 10 million +observations going back almost a century. &kstars; downloads the very +latest data directly from the <abbrev>AAVSO</abbrev> database via the +Internet, so a network connection is required to use this tool. +</para> +<para> +To use the tool, select a variable star either by +<firstterm>designation</firstterm> or name in the left panel, and +set the start and end dates to be plotted. In the right panel, +select the type of data that should be plotted (see below). When you have +made you selections, press the <guibutton>Retrieve Curve</guibutton> +button. &kstars; will automatically connect to the AAVSO server, +which will generate the lightcurve plot and send it to your computer for +display. A sample lightcurve plot is shown below: +</para> + +<screenshot> +<screeninfo> +A Sample Lightcurve +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="lightcurve.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Sample Lightcurve</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +Please not these light curves should <emphasis>NEVER</emphasis> be used +in research, papers, presentations, publications, &etc;. They are only +meant to be used as a source of info for &kstars;. They have not been +validated and passed the <abbrev>AAVSO</abbrev>'s strict quality control +measures. We will be glad to give you good raw data simply by requesting +it at <ulink url="http://www.aavso.org/adata/onlinedata/">http://www.aavso.org/adata/onlinedata/</ulink>. +</para> +<para> +Specific questions about the data in the light curves can be sent to +<email>aavso@aavso.org</email>. +</para> +</sect2> + +<sect2 id="aavso-about"> +<title>About Variable Stars</title> +<para> +<firstterm>Variable stars</firstterm> are stars that change in +brightness. A <firstterm>light curve</firstterm> is a plot of a +variable star's brightness over time. By looking at a light curve you +can see how the star has behaved in the past and try to predict how it +will behave in the future. Astronomers also use this data to model +astrophysical processes in the star. This important to help us +understand how stars work. +</para> +</sect2> + +<sect2 id="aavso-data"> +<title>The Data</title> + +<para> +Here is a summary of the various types of data available in the light +curves: + +<itemizedlist> +<listitem><para><firstterm>Visual Observation</firstterm>: +This is an observation of a variable star by an observer with a +regular telescope. It means that an observer saw the star at Y +brightness on X date and time.</para></listitem> + +<listitem><para><firstterm>Fainter than</firstterm>: +Sometimes the star is too faint to be seen by the observer. When that +happens, the observer reports the faintest star seen in the field. +These are called <quote>fainter thans</quote> because the variable star +was fainter than the brightness reported.</para></listitem> + +<listitem><para><firstterm>Average</firstterm>: +This is a computed running average of all the data reported. The +<firstterm>bin</firstterm> number tells the computer how many days to +use in each average calculation. This will need to be adjusted based on +the frequency of observations. The error bars represent the 1 sigma +standard deviation of error.</para></listitem> + +<listitem><para><firstterm>CCDV</firstterm>: +These are observations reported using a <abbrev>CCD</abbrev> with a +Johnson <abbrev>V</abbrev> filter. <abbrev>CCDV</abbrev> observations +tend to be more accurate than visual (but not +always).</para></listitem> + +<listitem><para><firstterm>CCDB</firstterm>: +<abbrev>CCD</abbrev> observations with a Johnson <abbrev>B</abbrev> +filter.</para></listitem> + +<listitem><para><firstterm>CCDI</firstterm>: +<abbrev>CCD</abbrev> observations with a Cousins <abbrev>Ic</abbrev> +filter.</para></listitem> + +<listitem><para><firstterm>CCDR</firstterm>: +<abbrev>CCD</abbrev> observations with a Cousins <abbrev>R</abbrev> +filter.</para></listitem> + +<listitem><para><firstterm>Discrepant Data</firstterm>: +This is data that has been flagged by an <abbrev>AAVSO</abbrev> staff +member as being discrepant following <abbrev>HQ</abbrev> rules for +data validation. Contact <email>aavso@aavso.org</email> for more +information.</para></listitem> + +<listitem><para><firstterm>Dates</firstterm>: +The observational database the light curves are based on is updated +every 10 minutes so you can get data in near real-time. Right now +light curve data is only available back to 1961, but this will likely +be expanded further back in time in the future.</para></listitem> + +</itemizedlist> +</para> +</sect2> + +<sect2 id="aavso-update"> +<title>Updating your local copy of Variable Stars</title> +<para> +The <abbrev>AAVSO</abbrev> publishes the +<ulink url="http://www.aavso.org/valnam.txt">full list of variable +stars</ulink> in their monitoring program. This file is updated +monthly with newly discovered variable stars. To sync the list that +&kstars; uses with the <abbrev>AAVSO</abbrev> master list, click +on the <guibutton>Update List</guibutton> button in the +<abbrev>AAVSO</abbrev> dialog. &kstars; will then attempt to +connect to the <abbrev>AAVSO</abbrev> database and download the +latest list. +</para> +<note> +<para> +The customized data stream provided by the AAVSO was implemented for +&kstars; by Aaron Price. Thank you, Aaron! +</para> +</note> +</sect2> +</sect1> + diff --git a/doc/kstars/luminosity.docbook b/doc/kstars/luminosity.docbook new file mode 100644 index 00000000..3a312ed7 --- /dev/null +++ b/doc/kstars/luminosity.docbook @@ -0,0 +1,54 @@ +<sect1 id="ai-luminosity"> + +<sect1info> + +<author> +<firstname>Jasem</firstname> +<surname>Mutlaq</surname> +<affiliation><address> +</address></affiliation> +</author> +</sect1info> + +<title>Luminosity</title> +<indexterm><primary>Luminosity</primary> +<seealso>Flux</seealso> +</indexterm> + +<para> +<firstterm>Luminosity</firstterm> is the amount of energy emitted by a star each second. +</para> + +<para> +All stars radiate light over a broad range of frequencies in the electromagnetic spectrum from the low energy radio waves up to the highly energetic gamma rays. A star that emits predominately in the ultra-violet region of the spectrum produces a total amount of energy magnitudes larger than that produced in a star that emits principally in the infrared. +Therefore, luminosity is a measure of energy emitted by a star over all wavelengths. The relationship between wavelength and energy was quantified by Einstein as +E = h * v +where v is the frequency, h is the Planck constant, and E is the photon energy in joules. +That is, shorter wavelengths (and thus higher frequencies) correspond to higher energies. +</para> + +<para> +For example, a wavelength of lambda = 10 meter lies in the radio region of the electromagnetic spectrum and has a frequency of + +f = c / lambda = 3 * 10^8 m/s / 10 = 30 MHz + +where c is the speed of light. +The energy of this photon is + +E = h * v = 6.625 * 10^-34 J s * 30 Mhz = 1.988 * 10^-26 joules. + +On the other hand, visible light has much shorter wavelengths and higher frequencies. A photon that has a wavelength of lambda = 5 * 10^-9 meters (A greenish photon) has an energy +E = 3.975 * 10^-17 joules which is over a billion times higher than the energy of a radio photon. Similarly, a photon of red light (wavelength lambda = 700 nm) has less energy +than a photon of violet light (wavelength lambda = 400 nm). +</para> + +<para> +Luminosity depends both on temperature and surface area. This makes sense because a burning log radiates more energy than a match, even though both have the same temperature. +Similarly, an iron rod heated to 2000 degrees emits more energy than when it is heated to only 200 degrees. +</para> + +<para> +Luminosity is a very fundamental quantity in Astronomy and Astrophysics. Much of what is learnt about celestial objects comes from analyzing their light. This is because the physical processes that occur inside stars gets recorded and transmitted by light. +Luminosity is measured in units of energy per second. Astronomers prefer to use Ergs, rather than Watts, when quantifying luminosity. +</para> +</sect1> diff --git a/doc/kstars/luminosity.png b/doc/kstars/luminosity.png Binary files differnew file mode 100644 index 00000000..b3b0324a --- /dev/null +++ b/doc/kstars/luminosity.png diff --git a/doc/kstars/luminosity_ex.png b/doc/kstars/luminosity_ex.png Binary files differnew file mode 100644 index 00000000..a8dc9f82 --- /dev/null +++ b/doc/kstars/luminosity_ex.png diff --git a/doc/kstars/magnitude.docbook b/doc/kstars/magnitude.docbook new file mode 100644 index 00000000..b38963cd --- /dev/null +++ b/doc/kstars/magnitude.docbook @@ -0,0 +1,80 @@ +<sect1 id="ai-magnitude"> +<sect1info> +<author> +<firstname>Girish</firstname> <surname>V</surname> +</author> +</sect1info> +<title>Magnitude Scale</title> +<indexterm><primary>Magnitude Scale</primary> +<seealso>Flux</seealso> +<seealso>Star Colors and Temperatures</seealso> +</indexterm> +<para> +2500 years ago, the ancient Greek astronomer Hipparchus classified the +brightnesses of visible stars in the sky on a scale from 1 to 6. He +called the very brightest stars in the sky <quote>first magnitude</quote>, and the +very faintest stars he could see <quote>sixth magnitude</quote>. Amazingly, two +and a half millenia later, Hipparchus's classification scheme is still +widely used by astronomers, although it has since been modernized and +quantified.</para> +<note><para>The magnitude scale runs backwards to what you +might expect: brighter stars have <emphasis>smaller</emphasis> +magnitudes than fainter stars. +</para> +</note> +<para> +The modern magnitude scale is a quantitative measurement of the +<firstterm>flux</firstterm> of light coming from a star, with a +logarithmic scaling: +</para><para> +m = m_0 - 2.5 log (F / F_0) +</para><para> +If you do not understand the math, this just says that the magnitude +of a given star (m) is different from that of some standard star (m_0) +by 2.5 times the logarithm of their flux ratio. The 2.5 *log factor +means that if the flux ratio is 100, the difference in magnitudes is 5 +mag. So, a 6th magnitude star is 100 times fainter than a 1st magnitude +star. The reason Hipparchus's simple classification translates to a +relatively complex function is that the human eye responds +logarithmically to light. +</para><para> +There are several different magnitude scales in use, each of which serves +a different purpose. The most common is the apparent magnitude scale; +this is just the measure of how bright stars (and other objects) look +to the human eye. The apparent magnitude scale defines the star Vega +to have magnitude 0.0, and assigns magnitudes to all other objects using +the above equation, and a measure of the flux ratio of each object to +Vega. +</para><para> +It is difficult to understand stars using just the apparent magnitudes. +Imagine two stars in the sky with the same apparent magnitude, so they +appear to be equally bright. You cannot know just by looking if the +two have the same <emphasis>intrinsic</emphasis> brightness; it is +possible that one star is intrinsically brighter, but further away. +If we knew the distances to the stars (see the <link +linkend="ai-parallax">parallax</link> article), we could account for +their distances and assign <firstterm>Absolute magnitudes</firstterm> +which would reflect their true, intrinsic brightness. The absolute +magnitude is defined as the apparent magnitude the star would have if +observed from a distance of 10 parsecs (1 parsec is 3.26 light-years, +or 3.1 x 10^18 cm). The absolute magnitude (M) can be determined +from the apparent magnitude (m) and the distance in parsecs (d) +using the formula: +</para><para> +M = m + 5 - 5 * log(d) (note that M=m when d=10). +</para><para> +The modern magnitude scale is no longer based on the +human eye; it is based on photographic plates and photoelectric +photometers. With telescopes, we can see objects much fainter than +Hipparchus could see with his unaided eyes, so the magnitude scale has +been extended beyond 6th magnitude. In fact, the Hubble Space Telescope +can image stars nearly as faint as 30th magnitude, which is one +<emphasis>trillion</emphasis> times fainter than Vega. +</para><para> +A final note: the magnitude is usually measured through a color filter +of some kind, and these magnitudes are denoted by a subscript +describing the filter (&ie;, m_V is the magnitude through a <quote>visual</quote> +filter, which is greenish; m_B is the magnitude through a blue filter; +m_pg is the photographic plate magnitude, &etc;). +</para> +</sect1> diff --git a/doc/kstars/man-celestrongps.1.docbook b/doc/kstars/man-celestrongps.1.docbook new file mode 100644 index 00000000..a362a549 --- /dev/null +++ b/doc/kstars/man-celestrongps.1.docbook @@ -0,0 +1,84 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>celestrongps</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>celestrongps</command></refname> +<refpurpose>Celestrong GPS driver for INDI telescope control</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>celestrongps</command> +<group><option>-v</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the <acronym>INDI</acronym> protocol. +<command>celestrongps</command> is a device driver for supporting particular +types of external hardware.</para> +<para>This driver is not intended to be run directly. Instead you should +use &kstars; to configure and operate your astronomical instruments. Most +operations can be found under the <guimenu>Devices</guimenu> menu in +&kstars;.</para> +<para>&kstars; will start the <acronym>INDI</acronym> server internally, and +the <acronym>INDI</acronym> server will in turn start this device +driver.</para> +<para>Much more detailed information can be found in the &kstars; handbook +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde; and forms part +of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option>-v</option></term> +<listitem><para>Write more verbose output to stderr</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>indiserver(1), kstars(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/kstars">help:/kstars</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kstars</parameter></userinput>).</para> + +<para>There is also further information available at <ulink +url="http://edu.kde.org/kstars/">the &kde; Edutainment +website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para><command>celestrongps</command> was written by &Jasem.Mutlaq;</para> +</refsect1> + +</refentry> diff --git a/doc/kstars/man-fliccd.1.docbook b/doc/kstars/man-fliccd.1.docbook new file mode 100644 index 00000000..de6f7550 --- /dev/null +++ b/doc/kstars/man-fliccd.1.docbook @@ -0,0 +1,86 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>fliccd</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>fliccd</command></refname> +<refpurpose>Finger Lakes Instruments CCD driver for INDI telescope control</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>fliccd</command> +<group><option>-v</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the <acronym>INDI</acronym> protocol. +<command>fliccd</command> is a device driver for supporting particular +types of external hardware.</para> +<para>This driver is not intended to be run directly. Instead you should +use &kstars; to configure and operate your astronomical instruments. Most +operations can be found under the <guimenu>Devices</guimenu> menu in +&kstars;.</para> +<para>&kstars; will start the <acronym>INDI</acronym> server internally, and +the <acronym>INDI</acronym> server will in turn start this device +driver.</para> +<para>Much more detailed information can be found in the &kstars; handbook +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde; and forms part +of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option>-v</option></term> +<listitem><para>Write more verbose output to stderr</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>indiserver(1), kstars(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/kstars">help:/kstars</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kstars</parameter></userinput>).</para> + +<para>There is also further information available at <ulink +url="http://edu.kde.org/kstars/">the &kde; Edutainment +website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para><command>fliccd</command> was written by &Jasem.Mutlaq;</para> +<para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para> + +</refsect1> + +</refentry> diff --git a/doc/kstars/man-indiserver.1.docbook b/doc/kstars/man-indiserver.1.docbook new file mode 100644 index 00000000..8e54ceb4 --- /dev/null +++ b/doc/kstars/man-indiserver.1.docbook @@ -0,0 +1,136 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>indiserver</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>indiserver</command></refname> +<refpurpose>INDI server for telescope control by KStars</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>indiserver</command> +<group choice="opt"><option>-p <replaceable>port</replaceable></option></group> +<group choice="opt"><option>-r +<replaceable>attempts</replaceable></option></group> +<group><option>-vv</option></group> +<group choice="req" rep="repeat"><option><replaceable>driver</replaceable></option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the INDI protocol. +<command>indiserver</command> is a server that sits between the &kstars; +user interface and the low-level hardware drivers.</para> +<para>The <acronym>INDI</acronym> server is a network server, int hat either +local or remote clients may connect to it to control astronomical +instruments. The <acronym>INDI</acronym> server must be running on the +machine that is physically connected to the astronomical instruments.</para> +<note><para>There is usually no need to run the <acronym>INDI</acronym> +server directly. Using the &kstars; device manager, you can set up +astronomical instruments and start or stop the <acronym>INDI</acronym> +server all from within &kstars;</para></note> +<para>Much more detailed information is available in the &kstars; handbook, +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde;, and forms part +of the &kde; edutainment module.</para> + +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry> +<term><option>-p <replaceable>port</replaceable></option></term> +<listitem><para>Alternate IP port. The default is 7624.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>-r +<replaceable>attempts</replaceable></option></term> +<listitem><para>Maximum attempts to restart, in case of a problem. The +default is 2.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>-vv</option></term> +<listitem><para>Be more verbose with output to stderr.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option><replaceable>driver</replaceable></option></term> +<listitem><para>The names of the <acronym>INDI</acronym> drivers to +run.</para> +<para>Currently available are:</para> +<itemizedlist> +<listitem><para><parameter>celestrongps</parameter> (Celestron +GPS)</para></listitem> +<listitem><para><parameter>fliccd</parameter> (Finger Lakes Instruments +CCD)</para></listitem> +<listitem><para><parameter>lx200_16</parameter> (LX200 16")</para> +</listitem> +<listitem><para><parameter>lx200autostar</parameter> (LX200 Autostar)</para> +</listitem> +<listitem><para><parameter>lx200classic</parameter> (LX200 Classic)</para> +</listitem> +<listitem><para><parameter>lx200generic</parameter> (LX200 Generic)</para> +</listitem> +<listitem><para><parameter>lx200gps</parameter> (LX200 GPS)</para> +</listitem> +<listitem><para><parameter>temma</parameter> (Temma Takahashi)</para> +</listitem> +<listitem><para><parameter>v4ldriver</parameter> (Video4Linux +Generic)</para> +</listitem> +<listitem><para><parameter>v4lphilips</parameter> (Philips Webcam)</para> +</listitem> +</itemizedlist> +</listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> + +<para>celestrongps(1), fliccd(1), lx200_16(1), lx200autostar(1), lx200classic(1), lx200generic(1), lx200gps(1), kstars(1), temma(1), v4ldriver(1), v4lphilips(1)</para> + +<para>More detailed user documentation is available in the &kstars; +handbook, which you can reach from <ulink url="help:/kstars">help:/kstars</ulink> (either enter this +<acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> <parameter>help:/kstars</parameter></userinput>).</para> +</refsect1> + +<refsect1> +<title>Examples</title> +<para>To start an <acronym>INDI</acronym> server running an LX200 GPS +driver, and listening to connections on port 8000:</para> +<screen><userinput><command>indiserver</command> <option>-p</option> <parameter>8000</parameter> <parameter>lx200gps</parameter></userinput></screen> +</refsect1> +<refsect1> +<title>Authors</title> +<!--FIXME: Who wrote the indiserver? --> +<para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para> +</refsect1> +</refentry> diff --git a/doc/kstars/man-lx200_16.1.docbook b/doc/kstars/man-lx200_16.1.docbook new file mode 100644 index 00000000..453d519b --- /dev/null +++ b/doc/kstars/man-lx200_16.1.docbook @@ -0,0 +1,85 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>lx200_16</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>lx200_16</command></refname> +<refpurpose>LX200 16" driver for INDI telescope control</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>lx200_16</command> +<group><option>-v</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the <acronym>INDI</acronym> protocol. +<command>lx200_16</command> is a device driver for supporting particular +types of external hardware.</para> +<para>This driver is not intended to be run directly. Instead you should +use &kstars; to configure and operate your astronomical instruments. Most +operations can be found under the <guimenu>Devices</guimenu> menu in +&kstars;.</para> +<para>&kstars; will start the <acronym>INDI</acronym> server internally, and +the <acronym>INDI</acronym> server will in turn start this device +driver.</para> +<para>Much more detailed information can be found in the &kstars; handbook +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde; and forms part +of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option>-v</option></term> +<listitem><para>Write more verbose output to stderr</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>indiserver(1), kstars(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/kstars">help:/kstars</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kstars</parameter></userinput>).</para> + +<para>There is also further information available at <ulink +url="http://edu.kde.org/kstars/">the &kde; Edutainment +website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para><command>lx200_16</command> was written by &Jasem.Mutlaq;</para> +<para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para> +</refsect1> + +</refentry> diff --git a/doc/kstars/man-lx200autostar.1.docbook b/doc/kstars/man-lx200autostar.1.docbook new file mode 100644 index 00000000..394aaf9c --- /dev/null +++ b/doc/kstars/man-lx200autostar.1.docbook @@ -0,0 +1,85 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>lx200autostar</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>lx200autostar</command></refname> +<refpurpose>LX200 Autostar driver for INDI telescope control</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>lx200autostar</command> +<group><option>-v</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the <acronym>INDI</acronym> protocol. +<command>lx200autostar</command> is a device driver for supporting particular +types of external hardware.</para> +<para>This driver is not intended to be run directly. Instead you should +use &kstars; to configure and operate your astronomical instruments. Most +operations can be found under the <guimenu>Devices</guimenu> menu in +&kstars;.</para> +<para>&kstars; will start the <acronym>INDI</acronym> server internally, and +the <acronym>INDI</acronym> server will in turn start this device +driver.</para> +<para>Much more detailed information can be found in the &kstars; handbook +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde; and forms part +of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option>-v</option></term> +<listitem><para>Write more verbose output to stderr</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>indiserver(1), kstars(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/kstars">help:/kstars</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kstars</parameter></userinput>).</para> + +<para>There is also further information available at <ulink +url="http://edu.kde.org/kstars/">the &kde; Edutainment +website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para><command>lx200autostar</command> was written by &Jasem.Mutlaq;</para> +<para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para> +</refsect1> + +</refentry> diff --git a/doc/kstars/man-lx200classic.1.docbook b/doc/kstars/man-lx200classic.1.docbook new file mode 100644 index 00000000..ca7fb7ee --- /dev/null +++ b/doc/kstars/man-lx200classic.1.docbook @@ -0,0 +1,85 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>lx200classic</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>lx200classic</command></refname> +<refpurpose>LX200 Classic driver for INDI telescope control</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>lx200classic</command> +<group><option>-v</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the <acronym>INDI</acronym> protocol. +<command>lx200classic</command> is a device driver for supporting particular +types of external hardware.</para> +<para>This driver is not intended to be run directly. Instead you should +use &kstars; to configure and operate your astronomical instruments. Most +operations can be found under the <guimenu>Devices</guimenu> menu in +&kstars;.</para> +<para>&kstars; will start the <acronym>INDI</acronym> server internally, and +the <acronym>INDI</acronym> server will in turn start this device +driver.</para> +<para>Much more detailed information can be found in the &kstars; handbook +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde; and forms part +of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option>-v</option></term> +<listitem><para>Write more verbose output to stderr</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>indiserver(1), kstars(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/kstars">help:/kstars</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kstars</parameter></userinput>).</para> + +<para>There is also further information available at <ulink +url="http://edu.kde.org/kstars/">the &kde; Edutainment +website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para><command>lx200classic</command> was written by &Jasem.Mutlaq;</para> +<para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para> +</refsect1> + +</refentry> diff --git a/doc/kstars/man-lx200generic.1.docbook b/doc/kstars/man-lx200generic.1.docbook new file mode 100644 index 00000000..a501500a --- /dev/null +++ b/doc/kstars/man-lx200generic.1.docbook @@ -0,0 +1,85 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>lx200gps</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>lx200gps</command></refname> +<refpurpose>LX200 GPS driver for INDI telescope control</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>lx200gps</command> +<group><option>-v</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the <acronym>INDI</acronym> protocol. +<command>lx200gps</command> is a device driver for supporting particular +types of external hardware.</para> +<para>This driver is not intended to be run directly. Instead you should +use &kstars; to configure and operate your astronomical instruments. Most +operations can be found under the <guimenu>Devices</guimenu> menu in +&kstars;.</para> +<para>&kstars; will start the <acronym>INDI</acronym> server internally, and +the <acronym>INDI</acronym> server will in turn start this device +driver.</para> +<para>Much more detailed information can be found in the &kstars; handbook +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde; and forms part +of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option>-v</option></term> +<listitem><para>Write more verbose output to stderr</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>indiserver(1), kstars(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/kstars">help:/kstars</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kstars</parameter></userinput>).</para> + +<para>There is also further information available at <ulink +url="http://edu.kde.org/kstars/">the &kde; Edutainment +website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para><command>lx200gps</command> was written by &Jasem.Mutlaq;</para> +<para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para> +</refsect1> + +</refentry> diff --git a/doc/kstars/man-temma.1.docbook b/doc/kstars/man-temma.1.docbook new file mode 100644 index 00000000..fd6e2e23 --- /dev/null +++ b/doc/kstars/man-temma.1.docbook @@ -0,0 +1,85 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>temma</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>temma</command></refname> +<refpurpose>Temma Takahashi driver for INDI telescope control</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>temma</command> +<group><option>-v</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the <acronym>INDI</acronym> protocol. +<command>temma</command> is a device driver for supporting particular +types of external hardware.</para> +<para>This driver is not intended to be run directly. Instead you should +use &kstars; to configure and operate your astronomical instruments. Most +operations can be found under the <guimenu>Devices</guimenu> menu in +&kstars;.</para> +<para>&kstars; will start the <acronym>INDI</acronym> server internally, and +the <acronym>INDI</acronym> server will in turn start this device +driver.</para> +<para>Much more detailed information can be found in the &kstars; handbook +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde; and forms part +of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option>-v</option></term> +<listitem><para>Write more verbose output to stderr</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>indiserver(1), kstars(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/kstars">help:/kstars</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kstars</parameter></userinput>).</para> + +<para>There is also further information available at <ulink +url="http://edu.kde.org/kstars/">the &kde; Edutainment +website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para><command>temma</command> was written by &Jasem.Mutlaq;</para> +<para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para> +</refsect1> + +</refentry> diff --git a/doc/kstars/man-v4ldriver.1.docbook b/doc/kstars/man-v4ldriver.1.docbook new file mode 100644 index 00000000..42bfaf43 --- /dev/null +++ b/doc/kstars/man-v4ldriver.1.docbook @@ -0,0 +1,85 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>v4ldriver</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>v4ldriver</command></refname> +<refpurpose>Video4Linux Generic driver for INDI telescope control</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>v4ldriver</command> +<group><option>-v</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the <acronym>INDI</acronym> protocol. +<command>v4ldriver</command> is a device driver for supporting particular +types of external hardware.</para> +<para>This driver is not intended to be run directly. Instead you should +use &kstars; to configure and operate your astronomical instruments. Most +operations can be found under the <guimenu>Devices</guimenu> menu in +&kstars;.</para> +<para>&kstars; will start the <acronym>INDI</acronym> server internally, and +the <acronym>INDI</acronym> server will in turn start this device +driver.</para> +<para>Much more detailed information can be found in the &kstars; handbook +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde; and forms part +of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option>-v</option></term> +<listitem><para>Write more verbose output to stderr</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>indiserver(1), kstars(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/kstars">help:/kstars</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kstars</parameter></userinput>).</para> + +<para>There is also further information available at <ulink +url="http://edu.kde.org/kstars/">the &kde; Edutainment +website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para><command>v4ldriver</command> was written by &Jasem.Mutlaq;</para> +<para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para> +</refsect1> + +</refentry> diff --git a/doc/kstars/man-v4lphilips.1.docbook b/doc/kstars/man-v4lphilips.1.docbook new file mode 100644 index 00000000..302fbd19 --- /dev/null +++ b/doc/kstars/man-v4lphilips.1.docbook @@ -0,0 +1,85 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>v4lphilips</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>v4lphilips</command></refname> +<refpurpose>Video4Linux Philips Webcam driver for INDI telescope control</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>v4lphilips</command> +<group><option>-v</option></group> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kstars; allows you to configure and control astronomical instruments +such as telescopes and focusers via the <acronym>INDI</acronym> protocol. +<command>v4lphilips</command> is a device driver for supporting particular +types of external hardware.</para> +<para>This driver is not intended to be run directly. Instead you should +use &kstars; to configure and operate your astronomical instruments. Most +operations can be found under the <guimenu>Devices</guimenu> menu in +&kstars;.</para> +<para>&kstars; will start the <acronym>INDI</acronym> server internally, and +the <acronym>INDI</acronym> server will in turn start this device +driver.</para> +<para>Much more detailed information can be found in the &kstars; handbook +as described below.</para> +<para>&kstars; is a graphical desktop planetarium for &kde; and forms part +of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option>-v</option></term> +<listitem><para>Write more verbose output to stderr</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>indiserver(1), kstars(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/kstars">help:/kstars</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kstars</parameter></userinput>).</para> + +<para>There is also further information available at <ulink +url="http://edu.kde.org/kstars/">the &kde; Edutainment +website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para><command>v4lphilips</command> was written by &Jasem.Mutlaq;</para> +<para>This man page based on the one written for Debian by <personname><firstname>Ben</firstname><surname>Burton</surname></personname> <email>bab@debian.org</email></para> +</refsect1> + +</refentry> diff --git a/doc/kstars/meridian.docbook b/doc/kstars/meridian.docbook new file mode 100644 index 00000000..e6859127 --- /dev/null +++ b/doc/kstars/meridian.docbook @@ -0,0 +1,28 @@ +<sect1 id="ai-meridian"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>The Local Meridian</title> +<indexterm><primary>Local Meridian</primary> +<seealso>Hour Angle</seealso> +<seealso>Celestial Sphere</seealso> +</indexterm> +<para> +The Local Meridian is an imaginary <link linkend="ai-greatcircle">Great Circle</link> +on the <link linkend="ai-csphere">Celestial Sphere</link> that is perpendicular +to the local <link linkend="ai-horizon">Horizon</link>. It passes through the +North point on the Horizon, through the <link linkend="ai-cpoles">Celestial +Pole</link>, up to the <link linkend="ai-zenith">Zenith</link>, and through the +South point on the Horizon. +</para><para> +Because it is fixed to the local Horizon, stars will appear to drift past +the Local Meridian as the Earth spins. You can use an object's <link +linkend="equatorial">Right Ascension</link> and the <link +linkend="ai-sidereal">Local Sidereal Time</link> to determine when it will +cross your Local Meridian (see <link linkend="ai-hourangle">Hour Angle</link>). +</para> +</sect1> + diff --git a/doc/kstars/newfov.png b/doc/kstars/newfov.png Binary files differnew file mode 100644 index 00000000..37264dbd --- /dev/null +++ b/doc/kstars/newfov.png diff --git a/doc/kstars/observinglist.docbook b/doc/kstars/observinglist.docbook new file mode 100644 index 00000000..7a39610d --- /dev/null +++ b/doc/kstars/observinglist.docbook @@ -0,0 +1,99 @@ +<sect1 id="tool-observinglist"> +<title>Observing List Tool</title> +<indexterm><primary>Tools</primary> +<secondary>Observing List Tool</secondary> +</indexterm> + +<screenshot> +<screeninfo> +The Observing List Tool +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="observinglist.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Observing List Tool</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The purpose of the Observing List Tool is to provide convenient +access to some common functions for a list of objects chosen by +you. Objects are added to the list by using the <quote>Add to +List</quote> action in the <link linkend="popup-menu">popup +menu</link>, or by simply pressing the <keycap>O</keycap> key +to add the currently-selected object. +</para> +<para> +Objects in the list can be sorted by any of the data columns +(Name, Right Ascension, Declination, Magnitude, and Type). +To perform an action on an object, highlight it in the list, +and then press one of the Action buttons at the top of the +window. Some actions can be performed while multiple objects +are selected; others only operate when one object is selected. +The available actions are: + +<variablelist> +<varlistentry> +<term>Center</term> +<listitem> +<para> +Center the display on the selected object, and begin Tracking +it. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Scope</term> +<listitem> +<para> +Point your <link linkend="indi">telescope</link> at the +selected object. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Alt vs. Time</term> +<listitem> +<para> +Open the <link linkend="tool-altvstime">Altitude vs. Time +Tool</link>, with the selected object(s) preloaded +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Details</term> +<listitem> +<para> +Open the <link linkend="tool-details">Detailed Information +Window</link> for the selected object. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Remove</term> +<listitem> +<para> +Remove the selected object(s) from the observing list. +</para> +</listitem> +</varlistentry> + +</variablelist> +</para> + +<note> +<para> +The Observing List tool is a new feature and is still under +development. We are planning to add more features, such as +adding objects to the list by selecting a region in the sky, and +the ability to save observing lists to disk. +</para> +</note> +</sect1> diff --git a/doc/kstars/observinglist.png b/doc/kstars/observinglist.png Binary files differnew file mode 100644 index 00000000..3e14772d --- /dev/null +++ b/doc/kstars/observinglist.png diff --git a/doc/kstars/parallax.docbook b/doc/kstars/parallax.docbook new file mode 100644 index 00000000..688dd334 --- /dev/null +++ b/doc/kstars/parallax.docbook @@ -0,0 +1,65 @@ +<sect1 id="ai-parallax"> +<sect1info> +<author> +<firstname>James</firstname> <surname>Lindenschmidt</surname> +</author> +</sect1info> +<title>Parallax</title> +<indexterm><primary>Parallax</primary></indexterm> +<indexterm><primary>Astronomical Unit</primary><see>Parallax</see></indexterm> +<indexterm><primary>Parsec</primary><see>Parallax</see></indexterm> + <para> + <firstterm>Parallax</firstterm> is the apparent change of an observed + object's position caused by a shift in the observer's position. As an + example, hold your hand in front of you at arm's length, and observe + an object on the other side of the room behind your hand. Now tilt + your head to your right shoulder, and your hand will appear on the + left side of the distant object. Tilt your head to your left + shoulder, and your hand will appear to shift to the right side of the + distant object. + </para> + <para> + Because the Earth is in orbit around the Sun, we observe the sky from + a constantly moving position in space. Therefore, we should expect + to see an <firstterm>annual parallax</firstterm> effect, in which the + positions of nearby objects appear to <quote>wobble</quote> back and forth in + response to our motion around the Sun. This does in fact happen, but + the distances to even the nearest stars are so great that you need to + make careful observations with a telescope to detect + it<footnote><para>The ancient Greek astronomers knew about parallax; + because they could not observe an annual parallax in the positions of + stars, they concluded that the Earth could not be in motion around + the Sun. What they did not realize was that the stars are millions of + times further away than the Sun, so the parallax effect is impossible + to see with the unaided eye.</para></footnote>. + </para> + <para> + Modern telescopes allow astronomers to use the annual parallax to + measure the distance to nearby stars, using triangulation. The + astronomer carefully measures the position of the star on two dates, + spaced six months apart. The nearer the star is to the Sun, the +larger + the apparent shift in its position will be between the two dates. + </para> + <para> + Over the six-month period, the Earth has moved through half its orbit + around the Sun; in this time its position has changed by 2 + <firstterm>Astronomical Units</firstterm> (abbreviated AU; 1 AU is + the distance from the Earth to the Sun, or about 150 million + kilometers). This sounds like a really long distance, but even the + nearest star to the Sun (alpha Centauri) is about 40 + <emphasis>trillion</emphasis> kilometers away. Therefore, the annual + parallax is very small, typically smaller than one + <firstterm>arcsecond</firstterm>, which is only 1/3600 of one degree. + A convenient distance unit for nearby stars is the + <firstterm>parsec</firstterm>, which is short for "parallax + arcsecond". One parsec is the distance a star would have if its + observed parallax angle was one arcsecond. It is equal to 3.26 + light-years, or 31 trillion kilometers<footnote><para>Astronomers + like this unit so much that they now use <quote>kiloparsecs</quote> to measure + galaxy-scale distances, and <quote>Megaparsecs</quote> to measure intergalactic + distances, even though these distances are much too large to have an + actual, observable parallax. Other methods are required to determine + these distances</para></footnote>. + </para> +</sect1> diff --git a/doc/kstars/popup.png b/doc/kstars/popup.png Binary files differnew file mode 100644 index 00000000..d3741c08 --- /dev/null +++ b/doc/kstars/popup.png diff --git a/doc/kstars/precession.docbook b/doc/kstars/precession.docbook new file mode 100644 index 00000000..2e092263 --- /dev/null +++ b/doc/kstars/precession.docbook @@ -0,0 +1,54 @@ +<sect1 id="ai-precession"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>Precession</title> +<indexterm><primary>Precession</primary> +</indexterm> +<para> +<firstterm>Precession</firstterm> is the gradual change in the direction of the +Earth's spin axis. The spin axis traces a cone, completing a full circuit in +26,000 years. If you have ever spun a top or a dreidel, the +<quote>wobbling</quote> rotation of the top as it spins is precession. +</para><para> +Because the direction of the Earth's spin axis changes, so does the location of +the <link linkend="ai-cpoles">Celestial Poles</link>. +</para><para> +The reason for the Earth's precession is complicated. The Earth is not a +perfect sphere, it is a bit flattened, meaning the +<link linkend="ai-greatcircle">Great Circle</link> of the equator is longer +than a <quote>meridonal</quote> great circle that +passes through the poles. Also, the Moon and Sun lie outside the Earth's +Equatorial plane. As a result, the gravitational pull of the Moon and Sun on +the oblate Earth induces a slight <emphasis>torque</emphasis> in addition to a +linear force. This torque on the spinning body of the Earth leads to the +precessional motion. +</para> +<tip> +<para>Exercise:</para> +<para> +Precession is easiest to see by observing the <link +linkend="ai-cpoles">Celestial Pole</link>. To find the pole, first switch to +Equatorial Coordinates in the <guilabel>Configure &kstars;</guilabel> window, and +then hold down the <keycap>Up arrow</keycap> key until the display stops +scrolling. The declination displayed in the center of the +<guilabel>Info Panel</guilabel> should be +90 degrees, and the bright star +Polaris should be nearly at the center of the screen. Try slewing with the left +and right arrow keys. Notice that the sky appears to rotate around the Pole. +</para><para> +We will now demonstrate Precession by changing the Date to a very remote year, +and observing that the location of the Celestial Pole is no longer near Polaris. +Open the <guilabel>Set Time</guilabel> window +(<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>), and set the date +to the year 8000 (currently, &kstars; cannot handle dates much more remote than +this, but this date is sufficient for our purposes). Notice that the sky +display is now centered at a point between the constellations Cygnus and +Cepheus. Verify that this is actually the pole by slewing left and right: the +sky rotates about this point; in the year 8000, the North celestial pole will no +longer be near Polaris. +</para> +</tip> +</sect1> diff --git a/doc/kstars/quicktour.docbook b/doc/kstars/quicktour.docbook new file mode 100644 index 00000000..551eedb6 --- /dev/null +++ b/doc/kstars/quicktour.docbook @@ -0,0 +1,376 @@ +<chapter id="using-kstars"> +<title>A Quick Tour of &kstars;</title> + +<para> +This chapter presents a guided tour of &kstars;, introducing +many of its important features. +</para> + +<screenshot> +<screeninfo> +Here is a screenshot of the &kstars; main window: +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="screen1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Main Window</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The above screenshot shows a typical view of the KStars program. You +can see the sky display centered on Betelgeuse, the brightest star in +the constellation Orion. Orion has just risen above the eastern horizon. +Stars are displayed with <link linkend="ai-colorandtemp">realistic +colors</link> and relative brightnesses. If you look closely, you can +also see the Moon near the left edge of the window. In three corners +of the sky display, there are on-screen text labels displaying data on +the current time (<quote>LT: 16:41:39 22 Jan 2005</quote>), the current +Geographic Location (<quote>Tucson, Arizona, USA</quote>), and the +current object in the center of the display (<quote>Focused on: Betelgeuse +(alpha Orionis)</quote>). Above the sky display, there are two toolbars. +The main toolbar contains shortcuts for +<link linkend="kstars-menus">menu functions</link>, as well as a +time-step widget which controls how fast the simulation clock runs. +The view toolbar contains buttons that toggle the display of different +kinds of objects in the sky. At the bottom of the window, there is a +status bar which displays the name of any object you click on, and the +<link linkend="ai-skycoords">sky coordinates</link> (both +Right Ascension/Declination and Azimuth/Altitude) of the mouse cursor. +</para> + +<sect1 id="startwizard"> +<title>The Setup Wizard</title> +<para> +<indexterm><primary>Setup Wizard</primary></indexterm> +The first time you run KStars, you will be presented with a Setup Wizard, +which allows you to easily set your geographic location and download some +extra data files. You can press the <guilabel>Finish</guilabel> button +at any time to exit the Setup Wizard. +</para> + +<para> +The first page of the Setup Wizard allows you to choose the starting +geographic location, by selecting from the list of the 2500+ known +locations on the right side of the window. The list of locations can be +filtered to match the text you enter in the <guilabel>City</guilabel>, +<guilabel>Province</guilabel>, and <guilabel>Country</guilabel> edit +boxes. If your desired location is not present in the list, you can +select a nearby city instead for now. Later on, you can add your +precise location manually using the <link linkend="setgeo">Set Geographic +Location tool</link>. Once you have selected a starting location, press +the <guilabel>Next</guilabel> button. +</para> + +<para> +The second page of the Setup Wizard allows you to download extra data +that are not included with the standard distribution of &kstars;. +Simply press the <guilabel>Download Extra Data</guilabel> button to open +the <guilabel>Get New Stuff</guilabel> tool. When you are all done, +press the <guilabel>Finish</guilabel> button in the Setup Wizard to +start exploring &kstars;. +</para> + +<note> +<para> +The Download Extra Data tool is only available if you have KDE 3.3.x +installed. +</para> +</note> +</sect1> + +<sect1 id="lookaround"> +<title>Have a Look Around</title> +<para> +<indexterm><primary>Navigation Controls</primary> +<secondary>Basics</secondary></indexterm> +Now that we have the time and location set, let us have a look around. +You can pan the display using the arrow keys. If you hold down the +&Shift; key before panning, the scrolling speed is increased. The +display can also be panned by clicking and dragging with the mouse. +Note that while the display is scrolling, not all objects are +displayed. This is done to cut down on the <acronym>CPU</acronym> load +of recomputing object positions, which makes the scrolling smoother +(you can configure what gets hidden while scrolling in the <link +linkend="config">Configure &kstars;</link> window). + +There are seven ways to change the magnification (or +<firstterm>Zoom level</firstterm>) of the display:</para> + +<orderedlist> +<listitem> + <para>Use the <keycap>+</keycap> and + <keycap>-</keycap> keys</para> +</listitem> +<listitem> + <para>Press the Zoom In/Zoom Out buttons in the toolbar</para> +</listitem> +<listitem> + <para>Select + <guimenuitem>Zoom In</guimenuitem>/<guimenuitem>Zoom Out</guimenuitem> + from the <guimenu>View</guimenu> menu</para> +</listitem> +<listitem> + <para>Select <guimenuitem>Zoom to Angular Size...</guimenuitem> from + the <guimenu>View</guimenu> menu. This allows you to specify the + the field-of-view angle for the display, in degrees.</para> +</listitem> +<listitem> + <para>Use the scroll wheel on your mouse</para> +</listitem> +<listitem> + <para>Drag the mouse up and down with the &MMB; pressed.</para> +</listitem> +<listitem> + <para>Hold down &Ctrl; while dragging the mouse. This + will allow you to define a rectangle in the map. When you release the mouse + button, the display will zoom to match the rectangle.</para> +</listitem> +</orderedlist> + +<para>Notice that as you zoom in, you can see fainter stars than at +lower zoom settings.</para> + +<para> +Zoom out until you can see a green curve; this represents your local +<link linkend="ai-horizon">horizon</link>. If you have not adjusted +the default &kstars; configuration, the display will be solid green +below the horizon, representing the solid ground of the Earth. There +is also a white curve, which represents the <link +linkend="ai-cequator">celestial equator</link>, and a tan curve, which +represents the <link linkend="ai-ecliptic">Ecliptic</link>, the path +that the Sun appears to follow across the sky over the course of a +year. The Sun is always found somewhere along the Ecliptic, and the +planets are never far from it. +</para> +</sect1> + +<sect1 id="skyobjects"> +<title>Objects in the Sky</title> +<para> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Overview</secondary></indexterm> +&kstars; displays thousands of celestial objects: stars, planets, +comets, asteroids, clusters, nebulae and galaxies. You can interact +with displayed objects to perform actions on them or obtain more +information about them. Clicking on an object will identify it in the +status bar, and simply hovering the mouse cursor on an object will label +it temporarily in the map. Double-clicking will recenter the display on +the object and begin tracking it (so that it will remain centered as +time passes). <mousebutton>Right</mousebutton> clicking an object opens +the object's popup menu, which provides more options. +</para> + +<sect2 id="popupquick"> +<title>The Popup Menu</title> +<indexterm><primary>Popup Menu</primary><secondary>Example</secondary></indexterm> + +<para> +Here is an example of the <mousebutton>right</mousebutton> click popup +menu, for the Orion Nebula: +</para> + +<screenshot> +<screeninfo>Popup Menu for M 42</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="popup.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Popup Menu for M 42</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The appearance of the popup menu depends somewhat on the kind of +object you <mousebutton>right</mousebutton>-click on, but the basic +structure is listed below. You can get +<link linkend="popup-menu">more detailed information about the popup +menu</link>. +</para> + +<para> +The top section contains information labels (which are not selectable). +The top one to three labels display the object's name(s) and object +type. The next three labels show the object's rise, transit, and +set times. If the rise and set times say "circumpolar", it means that +the object is always above the horizon for the present location. +</para> +<para> +The middle section contains items for performing actions on the +object, such as <guimenuitem>Center and Track</guimenuitem>, +<guimenuitem>Details...</guimenuitem>, and +<guimenuitem>Attach Label</guimenuitem>. See the <link +linkend="popup-menu">popup menu description</link> for a full list +and description of each action. +</para> +<para> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Internet Links</secondary> +<seealso>Popup Menu</seealso></indexterm> +The bottom section contains links to images and/or informative webpages +about the selected object. If you know of an additional &URL; with +information or an image of the object, you can add a custom link to the +object's popup menu using the <guimenuitem>Add Link...</guimenuitem> +item. +</para> +</sect2> + +<sect2 id="findobjects"> +<title>Finding Objects</title> +<indexterm><primary>Find Object Tool</primary></indexterm> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Finding by Name</secondary></indexterm> +<para> +You can search for named objects using the <guilabel>Find +Object</guilabel> tool, which can be opened by clicking on the +<guiicon>search</guiicon> icon in the toolbar, by selecting +<guimenuitem>Find Object...</guimenuitem> from the +<guimenu>Pointing</guimenu> menu, or by pressing +<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>. +The <guilabel>Find Object</guilabel> window is shown below: + +<screenshot> +<screeninfo>Find Object Window</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="find.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Find Object Window</phrase> + </textobject> +</mediaobject> +</screenshot> +</para> + +<para> +The window contains a list of all the named objects that &kstars; is +aware of. Many of the objects only have a numeric catalog name (for +example, NGC 3077), but some objects have a common name as well (for +example, Whirlpool Galaxy). You can filter the list by name and +by object type. To filter by name, enter a string in the edit box +at the top of the window; the list will then only contain names +which start with that string. To filter by type, select a type +from the combo box at the bottom of the window. +</para><para> +To center the display on an object, highlight the desired object in +the list, and press <guibutton>Ok</guibutton>. Note that if the +object is below the horizon, the program will warn you that you may +not see anything except the ground (you can make the ground invisible +in the <guilabel>Display Options</guilabel> window, or by pressing the +<guiicon>Ground</guiicon> button in the View toolbar). +</para> +</sect2> + +<sect2 id="centertrack"> +<title>Centering and Tracking</title> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Tracking</secondary></indexterm> +<para> +&kstars; will automatically begin tracking on an object whenever one +is centered in the display, either by using the <guilabel>Find +Object</guilabel> window, by double-clicking on it, or by +selecting <guimenuitem>Center and Track</guimenuitem> from its +<mousebutton>right</mousebutton>-click popup menu. You can disengage +tracking by panning the display, pressing the <guiicon>Lock</guiicon> +icon in the Main toolbar, or selecting <guimenuitem>Track +Object</guimenuitem> from the <guimenu>Pointing</guimenu> menu. +</para> + +<note> +<para> +<indexterm><primary>Orbit Trails</primary> +<secondary>Attached to centered object</secondary> +</indexterm> +When tracking on a Solar System body, &kstars; will automatically +attach an <quote>orbit trail</quote>, showing the path of the body +across the sky. You will likely need to change the clock's timestep +to a large value (such as <quote>1 day</quote>) to see the trail. +</para> +</note> +</sect2> + +<sect2 id="objectactions"> +<title>Keyboard Actions</title> +<indexterm><primary>Objects in the Sky</primary> +<secondary>Keyboard Actions</secondary></indexterm> +<para> + +When you click on an object in the map, it becomes the +<firstterm>selected object</firstterm>, and its name is identified in +the statusbar. There are a number of quick key commands available +which act on the selected object: + +<variablelist> +<varlistentry> +<term><keycap>C</keycap></term> +<listitem> +<para>Center and Track on the selected object</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycap>D</keycap></term> +<listitem> +<para>Show the <link linkend="tool-details">Details window</link> +for the selected object</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycap>L</keycap></term> +<listitem> +<para>Toggle a visible name label on the selected object</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycap>O</keycap></term> +<listitem> +<para>Add the selected object to the +<link linkend="tool-observinglist">Observing List</link></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycap>T</keycap></term> +<listitem> +<para>Toggle a visible curve on the sky, showing the path of the +object across the sky (only applicable to Solar System bodies) +</para> +</listitem> +</varlistentry> + +</variablelist> +</para> + +<note> +<para> +By holding down the <keycap>Alt</keycap> key, you can perform +these actions on the centered object, rather than the selected +object. +</para> +</note> +</sect2> <!--object actions--> +</sect1> <!--objects in the sky--> + +<sect1 id="endtour"> +<title>End of the Tour</title> +<para> +This concludes the tour of &kstars;, although we have only scratched +the surface of the available features. &kstars; includes many useful +<link linkend="tools">astronomy tools</link>, it can directly +<link linkend="indi">control your telescope</link>, and it offers a +wide variety of <link linkend="config">configuration and +customization options</link>. In addition, this Handbook includes the +<link linkend="astroinfo">AstroInfo Project</link>, a series of short, +interlinked articles explaining some of the celestial and astrophysical +concepts behind &kstars;. +</para> +</sect1> + +</chapter> diff --git a/doc/kstars/retrograde.docbook b/doc/kstars/retrograde.docbook new file mode 100644 index 00000000..00f200ab --- /dev/null +++ b/doc/kstars/retrograde.docbook @@ -0,0 +1,44 @@ +<sect1 id="ai-retrograde"> +<sect1info> +<author> +<firstname>John</firstname> +<surname>Cirillo</surname> +</author> +</sect1info> +<title>Retrograde Motion</title> +<indexterm><primary>Retrograde Motion</primary> +</indexterm> + +<para> +<firstterm>Retrograde Motion</firstterm> is the orbital motion of a body in a +direction opposite that which is normal to spatial bodies within a given system. +</para><para> +When we observe the sky, we expect most objects to appear to move in a +particular direction with the passing of time. The apparent motion of +most bodies in the sky is from east to west. However it is possible to +observe a body moving west to east, such as an artificial satellite or +space shuttle that is orbiting eastward. This orbit is +considered Retrograde Motion. +</para><para> +Retrograde Motion is most often used in reference to the +motion of the outer planets (Mars, Jupiter, Saturn, and so forth). +Though these planets appear to move from east to west on a nightly +basis in response to the spin of the Earth, they are actually drifting +slowly eastward with respect to the stationary stars, which can be +observed by noting the position of these planets for several nights in a +row. This motion is normal for these planets, however, and not +considered Retrograde Motion. However, since the Earth completes its +orbit in a shorter period of time than these outer planets, we +occasionally overtake an outer planet, like a faster car on a +multiple-lane highway. When this occurs, the planet we are passing will +first appear to stop its eastward drift, and it will then +appear to drift back toward the west. This is Retrograde Motion, since +it is in a direction opposite that which is typical for planets. Finally, +as the Earth swings past the the planet in its orbit, they appear to +resume their normal west-to-east drift on successive nights. +</para><para> +This Retrograde Motion of the planets puzzled ancient Greek +astronomers, and was one reason why they named these bodies <quote>planets</quote> +which in Greek means <quote>wanderers</quote>. +</para> +</sect1> diff --git a/doc/kstars/screen1.png b/doc/kstars/screen1.png Binary files differnew file mode 100644 index 00000000..da20c085 --- /dev/null +++ b/doc/kstars/screen1.png diff --git a/doc/kstars/scriptbuilder.docbook b/doc/kstars/scriptbuilder.docbook new file mode 100644 index 00000000..3a2f57ce --- /dev/null +++ b/doc/kstars/scriptbuilder.docbook @@ -0,0 +1,300 @@ +<sect1 id="tool-scriptbuilder"> +<title>The Script Builder Tool</title> +<indexterm><primary>Tools</primary> +<secondary>Script Builder</secondary> +</indexterm> + +<para> +KDE applications can be controlled externally from another program, +from a console prompt, or from a shell script using the Desktop +COmmunication Protocol (<abbrev>DCOP</abbrev>). KStars takes +advantage of this feature to allow rather complex behaviors to be +scripted and played back at any time. This can be used, for example, +to create a classroom demo to illustrate an astronomical concept. +</para> +<para> +The problem with DCOP scripts is, writing them is a bit like +programming, and can seem a daunting task to those who do not have +programming experience. The Script Builder Tool provides a +<abbrev>GUI</abbrev> point-and-click interface for constructing +KStars DCOP scripts, making it very easy to create complex scripts. +</para> + +<sect2 id="sb-intro"> +<title>Introduction to the Script Builder</title> + +<para> +Before explaining how to use the Script Builder, I provide a very +brief introduction to all of the <abbrev>GUI</abbrev> components; +for more infomation, use the "What's This?" function. +</para> + +<screenshot> +<screeninfo> +The Script Builder Tool +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="scriptbuilder.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Script Builder Tool</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The Script Builder is shown in the above screenshot. The box on the +left is the <firstterm>Current Script box</firstterm>; it shows the +list of commands that comprise the current working script. The box +on the right is the <firstterm>Function Browser</firstterm>; it +displays the list of all available script functions. Below the +Function Browser, there is a small panel which will display short +documentation about the script function highlighted in the Function +Browser. The panel below the Current Script box is the +<firstterm>Function Arguments panel</firstterm>; when a function is +highlighted in the Current Script box, this panel will contain items +for specifying values for any arguments that the highlighted function +requires. +</para><para> +Along the top of the window, there is a row of buttons which operate +on the script as a whole. From left to right, they are: +<guibutton>New Script</guibutton>, <guibutton>Open Script</guibutton>, +<guibutton>Save Script</guibutton>, <guibutton>Save Script +As...</guibutton>, and <guibutton>Test Script</guibutton>. The +function of these buttons should be obvious, except perhaps the last +button. Pressing <guibutton>Test Script</guibutton> will attempt to +run the current script in the main KStars window. You should move +the Script Builder window out of the way before pressing this, so you +can see the results. +</para><para> +In the center of the window, there is a column of buttons which operate +on individual script functions. From top to bottom, they are: +<guibutton>Add Function</guibutton>, <guibutton>Remove +Function</guibutton>, <guibutton>Copy Function</guibutton>, +<guibutton>Move Up</guibutton>, and <guibutton>Move Down</guibutton>. +<guibutton>Add Function</guibutton> adds the currently-highlighted +function in the Function Browser to the Current Script box (you can +also add a function by double-clicking on it). The rest of the +buttons operate on the function highlighted in the Current Script box, +either removing it, duplicating it, or changing its position in the +current script. +</para> +</sect2> + +<sect2 id="sb-using"> +<title>Using the Script Builder</title> +<para> +In order to illustrate using the Script Builder, we present a small +tutorial example where we make a script that tracks the Moon while +the clock runs at an accelerated rate. +</para><para> +If we are going to track the Moon, we will need to point the display +at it first. The <firstterm>lookToward</firstterm> function +is used to do this. Highlight this function in the Function Browser, +and note the documentation displayed in the panel below the Browser. +Press the <guibutton>Add Function</guibutton> button to add this +function to the Current Script box. The Function Arguments panel +will now contain a combobox labeled <quote>dir</quote>, short for +direction. This is the direction in which the display should +be pointed. The combobox contains only the cardinal compass points, +not the Moon or any other objects. You can either enter +<quote>Moon</quote> in the box manually, or press the +<guibutton>Object</guibutton> button to use the <guilabel>Find +Object</guilabel> window to select the Moon from the list of named +objects. Note that, as usual, centering on an object automatically +engages object-tracking mode, so there is no need to add the +<firstterm>setTracking</firstterm> function after lookToward. +</para><para> +Now that we have taken care of pointing at the Moon, we next want to +make time pass at an accelerated rate. Use the +<firstterm>setClockScale</firstterm> function for this. Add it to +the script by double-clicking on it in the Function Browser. The +Function Arguments panel contains a timestep spinbox for setting the +desired time step for the simulation clock. Change the timestep to +3 hours. +</para><para> +OK, we have pointed at the Moon and accelerated the clock. Now we just +want the script to wait for several seconds while the display tracks +on the Moon. Add the <firstterm>waitFor</firstterm> function to the +script, and use the Function Arguments panel to specify that it should +wait for 20 seconds before continuing. +</para><para> +To finish up, let us reset the clock's timestep to the normal value +of 1 second. Add another instance of setClockScale, and set its value +to 1 sec. +</para><para> +Actually, we are not quite done yet. We should probably make sure that +the display is using Equatorial coordinates before the script tracks +the Moon with an accelerated time step. Otherwise, if the display is +using Horizontal coordinates, it will rotate very quickly through +large angles as the Moon rises and sets. This can be very confusing, +and is avoided by setting the View Option +<firstterm>UseAltAz</firstterm> to <quote>false</quote>. To change +any View Option, use the <firstterm>changeViewOption</firstterm> +function. Add this function to the script, and examine the Function +Arguments panel. There is a combobox which contains the list of all +options which can be adjusted by changeViewOption. Since we know +we want the UseAltAz option, we could simply select it from the +combobox. However, the list is quite long, and there is no +explanation of what each item is for. It therefore may be easier to +press the <guibutton>Browse Tree</guibutton> button, which will open +a window containing a tree view of the available options, organized by +topic. In addition, each item has a short explanation of what the +option does, and the data type of the option's value. We find +UseAltAz under the <guilabel>Skymap options</guilabel> category. +Just highlight this item and press <guibutton>OK</guibutton>, and it +will be selected in the combobox of the Function Arguments panel. +Finally, make its value <quote>false</quote> or <quote>0</quote>. +</para><para> +One more step: changing UseAltAz at the end of the script does us no +good; we need this to be changed before anything else happens. So, +make sure this function is highlighted in the Current Script box, +and press the <guibutton>Move Up</guibutton> button until it is the +first function. +</para><para> +Now that we have finished the script, we should save it to disk. +Press the <guibutton>Save Script</guibutton> button. This will first +open a window in which you can provide a name for the script, and fill +in your name as the author. Enter <quote>Tracking the Moon</quote> +for a name, and your name as the author, and press +<guibutton>OK</guibutton>. Next, you will see the standard &kde; Save +File dialog. Specify a filename for the script and press +<guibutton>OK</guibutton> to save the script. Note that if your +filename does not end with <quote>.kstars</quote>, this suffix +will be automatically attached. If you are curious, you can examine the +script file with any text editor. +</para><para> +Now that we have a completed script, we can run it in a couple of ways. +From a console prompt, you can simply execute the script as long as an +instance of KStars is currently running. Alternatively, you can execute +the script from within KStars using the <guimenuitem>Run +Script</guimenuitem> item in the <guimenu>File</guimenu> menu. +</para> +</sect2> + +<sect2 id="sb-indi"> + <title>Device Automation with INDI</title> + <para> + Device scheduling and automation is supported for all <link linkend="what-is-indi">INDI</link>-compliant devices. You can coordinate any number of devices to perform complex operations using &kstars; <link linkend="sb-intro">Script Builder</link>. This can be accomplished by using &kstars; INDI DCOP interface, which provides different classes of functions to suit your tasks. The INDI DCOP functions can be decomposed into five different classes. The following is a review of the functions and their arguments as supported in KStars. It it highly recommended to read the <link linkend="indi-concepts">INDI Concepts</link> section as we will employ key INDI concepts throughout this tutorial.</para> + <orderedlist> + <listitem><para>Generic Device Functions: Functions to establish/shutdown devices..etc.</para> + <itemizedlist> + <listitem><para><function>startINDI (QString deviceName, bool useLocal)</function> : Establish an INDI service either as local or server.</para></listitem> + <listitem><para><function>shutdownINDI (QString deviceName)</function> : Shutdown the INDI service.</para></listitem> + <listitem><para><function>switchINDI(QString deviceName, bool turnOn)</function> : Connect or Disconnect an INDI device.</para></listitem> + <listitem><para><function>setINDIPort(QString deviceName, QString port)</function> : Set the device's connection port.</para></listitem> + <listitem><para><function>setINDIAction(QString deviceName, QString action)</function> : Activate an INDI action. The action can be any <emphasis>element</emphasis> of a <emphasis>switch property</emphasis></para></listitem> + <listitem><para><function>waitForINDIAction(QString deviceName, QString action)</function> : Pause script execution until the specified action <emphasis>property</emphasis> returns with OK status.</para></listitem> + </itemizedlist> + </listitem> + <listitem><para>Telescope Functions: Functions to control the telescope motion and status.</para> + <itemizedlist> + <listitem><para><function>setINDIScopeAction(QString deviceName, QString action)</function> : Set the telescope mode or action. Available options are SLEW, TRACK, SYNC, PARK, and ABORT.</para></listitem> + <listitem><para><function>setINDITargetCoord(QString deviceName, double RA, double DEC)</function> : Set the telescope JNow target coordinates to <emphasis>RA</emphasis> and <emphasis>DEC</emphasis>.</para></listitem> + <listitem><para><function>setINDITargetName(QString deviceName, QString objectName)</function> : Set the telescope JNow target coordinates to the coordinates of <emphasis>objectName</emphasis>. KStars will lookup the object name in its database and will fetch RA and Dec once found.</para></listitem> + <listitem><para><function>setINDIGeoLocation(QString deviceName, double +longitude, double latitude)</function> : Set the telescope geographical +location to the longitude and latitude as specified. The longitude is measured +from Greenwich, UK, to the East. However, while it is common to use negative +longitudes for the Western hemisphere, INDI requires longitude values between +0 and 360 degrees. So if you have a negative longitude, simply add 360 +degrees to get the value that INDI expects. For example, Calgary, Canada +coordinates in &kstars; are longitude: -114 04 58; latitude: 51 02 58. So +INDI's would need longitude = 360 - 114.083 = 245.917 +degrees.</para></listitem> + <listitem><para><function>setINDIUTC(QString ddeviceName, QString UTCDateTime)</function> : Set the telescope UTC Date and Time in ISO 8601 format. The format is YYYY-MM-DDTHH:MM:SS (e.g. 2004-07-12T22:05:32).</para></listitem> + </itemizedlist> + </listitem> + <listitem><para>Camera/CCD Functions: Functions to control the camera/CCD properties and status.</para> + <itemizedlist> + <listitem><para><function>setINDICCDTemp(QString deviceName, int temp)</function> : Set the CCD chip target temperature in degrees celsius.</para></listitem> + <listitem><para><function>setINDIFrameType(QString deviceName, QString type)</function> : Set the CCD frame type. Available options are FRAME_LIGHT, FRAME_BIAS, FRAME_DARK, and FRAME_FLAT.</para></listitem> + <listitem><para><function>startINDIExposure(QString deviceName, int timeout)</function> : Start the CCD/Camera exposure for the duration specified by <emphasis>timeout</emphasis> in seconds.</para></listitem> + </itemizedlist> + </listitem> + <listitem><para>Focuser Functions: Functions to control the focuser motion and status.</para> + <itemizedlist> + <listitem><para><function>setINDIFocusSpeed(QString deviceName, QString action)</function> : Set the focuser speed. Available options are FOCUS_HALT, FOCUS_SLOW, FOCUS_MEDIUM, and FOCUS_FAST.</para></listitem> + <listitem><para><function>setINDIFocusTimeout(QString deviceName, int timeout)</function> : Set the duration in seconds for any subsequent startINDIFocus operations.</para></listitem> + <listitem><para><function>startINDIFocus(QString deviceName, int focusDir)</function> : Move the focuser either inward (focusDir = 0) or outward (focusDir = 1). The speed and duration of this operation is set by the <function>setINDIFocusSpeed()</function> and <function>setINDIFocusTimeout()</function> functions.</para></listitem> + </itemizedlist> + </listitem> + <listitem><para>Filter Functions: Functions to control the filter position.</para> + <itemizedlist> + <listitem><para><function>setINDIFilterNum(QString deviceName, int filter_num)</function> : Change the filter position to <varname>filter_num</varname>. The user can assign aliases to filter numbers in the <guimenuitem>Configure INDI</guimenuitem> dialog box under the <guimenu>Devices</guimenu> menu (e.g. Filter 1 = Red, Filter 2 = Green..etc).</para></listitem> + </itemizedlist> + </listitem> + + </orderedlist> + +<para> +Note that the device name is the first argument of all INDI functions. This permits different commands that are sent to different INDI devices to be intermixed together in one script. The Script Builder tool provides two options to facilitate the creation and editing of INDI scripts:</para> +<itemizedlist> + <listitem><para><option>Append waitForINDIAction after any INDI action</option> : When checked, the Script Builder tool will automatically add <function>waitForINDIAction()</function> after any action it recognizes. For example, If you add <function>switchINDI()</function> function to the script and this option was checked, the Script Builder will add "waitForINDIAction CONNECTION" in the script file just after <function>switchINDI()</function>. This will cause the script to pause after it issues <function>switchINDI()</function> until <function>switchINDI()</function> returns with OK status (&ie; device connection was successful). It is critically important to know that the Script Builder cannot automatically add <function>waitForINDIAction()</function> for generic actions added using the <function>setINDIAction()</function> function. This is because KStars cannot determine the parent property of generic actions. Therefore, you must manually add <function>waitForINDIAction()</function> after generic actions when desired.</para> + </listitem> + <listitem><para><option>Reuse INDI device name</option> : When checked, the device name field of all subsequent functions is automatically filled with the last device name. The last device name is set every time <function>startINDI()</function> function is added to the current script. When working with multiple devices, it is recommended to have this option off.</para> + </listitem> +</itemizedlist> + +<para>Now we are ready to create a demo script that controls LX200 GPS telescope, in addition to Finger Lakes CCD camera. Our task is simple. We will ask the telescope to slew and track Mars, then we will ask the camera to take three shots 10 seconds each separated by 20 seconds.</para> +<important><para>Since there is no direct feedback from the INDI DCOP interface about the progress, value, or status of the device operations and parameters (except for <function>waitForINDIAction()</function>), device automation in KStars is similar to an open-loop control system. In such a system, there is usually no direct feedback to measure the progress of the system and to correct for errors. Consequently, you must design your device automation scripts with careful consideration. All automation scripts must be subjected to rigorous testing before deployment.</para></important> + +<screenshot> + <screeninfo> + The Script Builder Tool + </screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="indiscript.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Script Builder Tool</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para>The demo script is shown in the above screenshot. Note that we checked <option>"Append waitForINDIAction after any INDI action"</option> and unchecked <option>"Reuse INDI device name"</option>. The first function to add is <function>startINDI()</function> as shown above. We want to run our devices as local, so we will not change the service mode provided in the function arguments window. We type in our device name, starting with the telescope "LX200 GPS". We repeat the same operation again for "FLI CCD". There is a <function>waitFor()</function> function after that. It is generally recommended to use <function>waitFor()</function> function immediately after <function>startINDI()</function> to pause the script for 1-5 seconds. This will ensure that all properties are built and are ready to receive command. It is also useful for controlling remote devices because retrieving and building properties might take some time. In the next function, <function>switchINDI()</function>, we connect to each device.</para> + +<para>Since <option>"Append waitForINDIAction after any INDI action"</option> is checked, we do not need to add <function>waitForINDIAction()</function> after <function>switchINDI()</function> to insure that we only continue executing the script after we successfully connect. This is because the Script Builder tool will do this automatically for us when we save the script. Now let us set the telescope mode to tracking, click on the <function>setINDIScopeAction()</function> function and select TRACK. Note that we need to set the telescope to tracking <emphasis>before</emphasis> issuing the coordinates it needs to track. The <function>setINDIScopeAction()</function> function is provided for convenience; since in this example, it simply issues a generic <function>setINDIAction()</function> function followed by the keyword TRACK. However, the benefit of using <function>setINDIScopeAction()</function> is that KStars can automatically append <function>waitForINDIAction()</function> after it when required. This facility is not automatically available to generic actions as we discussed before.</para> + +<para>Next we use the <function>setINDITargetName()</function> function and set it to Mars. Finally, the last few steps involve capturing an image for 10 seconds which can be done by using <function>startINDIExposure()</function> function, and waiting for 20 seconds in between which can be done by using <function>waitFor()</function> function with a value of 20.</para> + +<para>We can now save our script and execute it at any time. The saved script will be similar to this:</para> +<blockquote><programlisting> + #!/bin/bash + #KStars DCOP script: Demo Script + #by Jasem Mutlaq + #last modified: Thu Jan 6 2005 09:58:26 + # + KSTARS=`dcopfind -a 'kstars*'` + MAIN=KStarsInterface + CLOCK=clock#1 + dcop $KSTARS $MAIN startINDI "LX200 GPS" true + dcop $KSTARS $MAIN startINDI "FLI CCD" true + dcop $KSTARS $MAIN waitFor 3 + dcop $KSTARS $MAIN switchINDI "LX200 GPS" true + dcop $KSTARS $MAIN waitForINDIAction "LX200 GPS" CONNECTION + dcop $KSTARS $MAIN switchINDI "FLI CCD" true + dcop $KSTARS $MAIN waitForINDIAction "FLI CCD" CONNECTION + dcop $KSTARS $MAIN setINDIScopeAction "LX200 GPS" TRACK + dcop $KSTARS $MAIN waitForINDIAction "LX200 GPS" ON_COORD_SET + dcop $KSTARS $MAIN setINDITargetName "LX200 GPS" Mars + dcop $KSTARS $MAIN waitForINDIAction "LX200 GPS" EQUATORIAL_EOD_COORD + dcop $KSTARS $MAIN startINDIExposure "FLI CCD" 10 + dcop $KSTARS $MAIN waitForINDIAction "FLI CCD" EXPOSE_DURATION + dcop $KSTARS $MAIN waitFor 20 + dcop $KSTARS $MAIN startINDIExposure "FLI CCD" 10 + dcop $KSTARS $MAIN waitForINDIAction "FLI CCD" EXPOSE_DURATION + dcop $KSTARS $MAIN waitFor 20 + dcop $KSTARS $MAIN startINDIExposure "FLI CCD" 10 + dcop $KSTARS $MAIN waitForINDIAction "FLI CCD" EXPOSE_DURATION +</programlisting> +</blockquote> + +<note> +<para>The INDI Library provides robust scripting tools that enable developers to orchestrate very complex scripts. For more details, refer to the <ulink url="http://indi.sourceforge.net/manual/book1.html">INDI Developer Manual</ulink>.</para> +</note> +</sect2> +</sect1> + diff --git a/doc/kstars/scriptbuilder.png b/doc/kstars/scriptbuilder.png Binary files differnew file mode 100644 index 00000000..2ada4982 --- /dev/null +++ b/doc/kstars/scriptbuilder.png diff --git a/doc/kstars/sidereal.docbook b/doc/kstars/sidereal.docbook new file mode 100644 index 00000000..a60ab44d --- /dev/null +++ b/doc/kstars/sidereal.docbook @@ -0,0 +1,80 @@ +<sect1 id="ai-sidereal"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>Sidereal Time</title> +<indexterm><primary>Sidereal Time</primary> +<seealso>Hour Angle</seealso> +</indexterm> +<para> +<firstterm>Sidereal Time</firstterm> literally means <quote>star time</quote>. +The time we are used to using in our everyday lives is Solar Time. The +fundamental unit of Solar Time is a <firstterm>Day</firstterm>: the time it +takes the Sun to travel 360 degrees around the sky, due to the rotation of the +Earth. Smaller units of Solar Time are just divisions of a Day: +</para><para> +<itemizedlist> +<listitem><para>1/24 Day = 1 Hour</para></listitem> +<listitem><para>1/60 Hour = 1 Minute</para></listitem> +<listitem><para>1/60 Minute = 1 Second</para></listitem> +</itemizedlist> +</para><para> +However, there is a problem with Solar Time. The Earth does not actually +spin around 360 degrees in one Solar Day. The Earth is in orbit around the +Sun, and over the course of one day, it moves about one Degree along its +orbit (360 degrees/365.25 Days for a full orbit = about one Degree per +Day). So, in 24 hours, the direction toward the Sun changes by about a +Degree. Therefore, the Earth has to spin 361 degrees to make +the Sun look like it has traveled 360 degrees around the Sky. +</para><para> +In astronomy, we are concerned with how long it takes the Earth to spin +with respect to the <quote>fixed</quote> stars, not the Sun. So, we would like a +timescale that removes the complication of Earth's orbit around the Sun, +and just focuses on how long it takes the Earth to spin 360 degrees with +respect to the stars. This rotational period is called a <firstterm>Sidereal +Day</firstterm>. On average, it is 4 minutes shorter than a Solar Day, because +of the extra 1 degree the Earth spins in a Solar Day. +Rather than defining a Sidereal Day to be 23 hours, 56 minutes, we define +Sidereal Hours, Minutes and Seconds that are the same fraction of a Day as +their Solar counterparts. Therefore, one Solar Second = 1.00278 Sidereal +Seconds. +</para><para> +The Sidereal Time is useful for determining where the stars are at any +given time. Sidereal Time divides one full spin of the Earth into 24 +Sidereal Hours; similarly, the map of the sky is divided into 24 Hours +of <firstterm>Right Ascension</firstterm>. This is no +coincidence; Local Sidereal Time (<acronym>LST</acronym>) indicates the Right +Ascension on the sky that is currently crossing the <link +linkend="ai-meridian">Local Meridian</link>. So, if a star has a Right +Ascension of 05h 32m 24s, it will be on your meridian at LST=05:32:24. More +generally, the difference between an object's <acronym>RA</acronym> and the Local +Sidereal Time tells you how far from the Meridian the object is. For example, +the same object at LST=06:32:24 (one Sidereal Hour later), will be one Hour of +Right Ascension west of your meridian, which is 15 degrees. This angular +distance from the meridian is called the object's <link +linkend="ai-hourangle">Hour Angle</link>. +</para> +<tip> +<para> +The Local Sidereal Time is displayed by &kstars; in the <guilabel>Time Info +Box</guilabel>, with the label <quote>ST</quote> (you have to +<quote>unshade</quote> the box by double-clicking it in order to see the +sidereal time). Note that the changing sidereal seconds are not synchronized +with the changing Local Time and Universal Time seconds. In fact, if you watch +the clocks for a while, you will notice that the Sidereal seconds really are +slightly shorter than the LT and UT seconds. +</para><para> +Point to the <link linkend="ai-zenith">Zenith</link> (press <keycap>Z</keycap> +or select <guimenuitem>Zenith</guimenuitem> from the +<guimenu>Pointing</guimenu> +menu). The Zenith is the point on the sky where you are looking <quote>straight +up</quote> from the ground, and it is a point on your <link +linkend="ai-meridian">Local Meridian</link>. Note the Right Ascension of the +Zenith: it is exactly the same as your Local Sidereal Time. +</para> +</tip> +</sect1> + diff --git a/doc/kstars/skycoords.docbook b/doc/kstars/skycoords.docbook new file mode 100644 index 00000000..1017be06 --- /dev/null +++ b/doc/kstars/skycoords.docbook @@ -0,0 +1,152 @@ +<sect1 id="ai-skycoords"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>Celestial Coordinate Systems</title> +<para> +<indexterm><primary>Celestial Coordinate Systems</primary> +<secondary>Overview</secondary></indexterm> +A basic requirement for studying the heavens is determining where in the +sky things are. To specify sky positions, astronomers have developed +several <firstterm>coordinate systems</firstterm>. Each uses a coordinate grid +projected on the <link linkend="ai-csphere">Celestial Sphere</link>, in +analogy to the <link linkend="ai-geocoords">Geographic coordinate +system</link> used on the surface of the Earth. The coordinate systems +differ only in their choice of the <firstterm>fundamental plane</firstterm>, +which divides the sky into two equal hemispheres along a <link +linkend="ai-greatcircle">great circle</link>. (the fundamental plane of the +geographic system is the Earth's equator). Each coordinate system is named for +its choice of fundamental plane. +</para> + +<sect2 id="equatorial"> +<title>The Equatorial Coordinate System</title> +<indexterm><primary>Celestial Coordinate Systems</primary> +<secondary>Equatorial Coordinates</secondary> +<seealso>Celestial Equator</seealso> +<seealso>Celestial Poles</seealso> +<seealso>Geographic Coordinate System</seealso> +</indexterm> +<indexterm><primary>Right Ascension</primary><see>Equatorial Coordinates</see></indexterm> +<indexterm><primary>Declination</primary><see>Equatorial Coordinates</see></indexterm> + +<para> +The <firstterm>Equatorial coordinate system</firstterm> is probably the most +widely used celestial coordinate system. It is also the most closely related +to the <link linkend="ai-geocoords">Geographic coordinate system</link>, because +they use the same fundamental plane, and the same poles. The projection of the +Earth's equator onto the celestial sphere is called the +<link linkend="ai-cequator">Celestial Equator</link>. +Similarly, projecting the geographic Poles onto the celestial sphere defines the +North and South <link linkend="ai-cpoles">Celestial Poles</link>. +</para><para> +However, there is an important difference between the equatorial and +geographic coordinate systems: the geographic system is fixed to the +Earth; it rotates as the Earth does. The Equatorial system is +fixed to the stars<footnote id="fn-precess"><para>actually, the equatorial +coordinates are not quite fixed to the stars. See <link +linkend="ai-precession">precession</link>. Also, if <link +linkend="ai-hourangle">Hour Angle</link> is used in place of Right +Ascension, then the Equatorial system is fixed to the Earth, not to the +stars.</para></footnote>, so it appears to rotate across the sky with the stars, +but of course it is really the Earth rotating under the fixed sky. +</para><para> +The <firstterm>latitudinal</firstterm> (latitude-like) angle of the Equatorial +system is called <firstterm>Declination</firstterm> (Dec for short). It +measures the angle of an object above or below the Celestial Equator. The +<firstterm>longitudinal</firstterm> angle is called the <firstterm>Right +Ascension</firstterm> (<acronym>RA</acronym> for short). It measures the angle of an object East +of the <link linkend="ai-equinox">Vernal Equinox</link>. Unlike longitude, +Right Ascension is usually measured in hours instead of degrees, because the +apparent rotation of the Equatorial coordinate system is closely related to +<link linkend="ai-sidereal">Sidereal Time</link> and <link +linkend="ai-hourangle">Hour Angle</link>. Since a full rotation of the sky +takes 24 hours to complete, there are (360 degrees / 24 hours) = 15 degrees in +one Hour of Right Ascension. +</para> +</sect2> + +<sect2 id="horizontal"> +<title>The Horizontal Coordinate System</title> + +<indexterm><primary>Celestial Coordinate Systems</primary> +<secondary>Horizontal Coordinates</secondary> +<seealso>Horizon</seealso> +<seealso>Zenith</seealso> +</indexterm> +<indexterm><primary>Azimuth</primary><see>Horizontal Coordinates</see></indexterm> +<indexterm><primary>Altitude</primary><see>Horizontal Coordinates</see></indexterm> +<para> +The Horizontal coordinate system uses the observer's local <link +linkend="ai-horizon">horizon</link> as the Fundamental Plane. This conveniently +divides the sky into the upper hemisphere that you can see, and the lower +hemisphere that you can't (because the Earth is in the way). The pole of the +upper hemisphere is called the <link linkend="ai-zenith">Zenith</link>. The +pole of the lower hemisphere is called the <firstterm>nadir</firstterm>. The +angle of an object above or below the horizon is called the +<firstterm>Altitude</firstterm> (Alt for short). The angle of an object around +the horizon (measured from the North point, toward the East) is called the +<firstterm>Azimuth</firstterm>. The Horizontal Coordinate System is sometimes +also called the Alt/Az Coordinate System. +</para><para> +The Horizontal Coordinate System is fixed to the Earth, not the Stars. +Therefore, the Altitude and Azimuth of an object changes with time, as the +object appears to drift across the sky. In addition, because the Horizontal +system is defined by your local horizon, the same object viewed from different +locations on Earth at the same time will have different values of Altitude and +Azimuth. +</para><para> +Horizontal coordinates are very useful for determining the Rise and Set times of +an object in the sky. When an object has Altitude=0 degrees, it is either +Rising (if its Azimuth is < 180 degrees) or Setting (if its Azimuth is > +180 degrees). +</para> +</sect2> + +<sect2 id="ecliptic"> +<title>The Ecliptic Coordinate System</title> + +<indexterm><primary>Celestial Coordinate Systems</primary> +<secondary>Ecliptic Coordinates</secondary> +<seealso>Ecliptic</seealso> +</indexterm> +<para> +The Ecliptic coordinate system uses the <link +linkend="ai-ecliptic">Ecliptic</link> for its Fundamental Plane. The +Ecliptic is the path that the Sun appears to follow across the sky over +the course of a year. It is also the projection of the Earth's +orbital plane onto the Celestial Sphere. The latitudinal angle is +called the <firstterm>Ecliptic Latitude</firstterm>, and the longitudinal angle +is called the <firstterm>Ecliptic Longitude</firstterm>. Like Right Ascension +in the Equatorial system, the zeropoint of the Ecliptic Longitude is the <link +linkend="ai-equinox">Vernal Equinox</link>. +</para><para> +What do you think such a coordinate system would be useful for? If you +guessed charting solar system objects, you are right! Each of the +planets (except Pluto) orbits the Sun in roughly the same plane, so they always +appear to be somewhere near the Ecliptic (&ie;, they always have small ecliptic +latitudes). +</para> +</sect2> + +<sect2 id="galactic"> +<title>The Galactic Coordinate System</title> + +<indexterm><primary>Celestial Coordinate Systems</primary> +<secondary>Galactic Coordinates</secondary> +</indexterm> +<para> +<indexterm><primary>Milky Way</primary></indexterm> +The Galactic coordinate system uses the <firstterm>Milky Way</firstterm> as its +Fundamental Plane. The latitudinal angle is called the <firstterm>Galactic +Latitude</firstterm>, and the longitudinal angle is called the +<firstterm>Galactic Longitude</firstterm>. This coordinate system is useful for +studying the Galaxy itself. For example, you might want to know how the density +of stars changes as a function of Galactic Latitude, to how much the disk of the +Milky Way is flattened. +</para> +</sect2> +</sect1> diff --git a/doc/kstars/skymapdevice.png b/doc/kstars/skymapdevice.png Binary files differnew file mode 100644 index 00000000..b4a2f661 --- /dev/null +++ b/doc/kstars/skymapdevice.png diff --git a/doc/kstars/solarsys.docbook b/doc/kstars/solarsys.docbook new file mode 100644 index 00000000..b3a5a07b --- /dev/null +++ b/doc/kstars/solarsys.docbook @@ -0,0 +1,53 @@ +<sect1 id="tool-solarsys"> +<title>Solar System Viewer</title> +<indexterm><primary>Tools</primary> +<secondary>Solar System Viewer</secondary> +</indexterm> + +<screenshot> +<screeninfo> +The Solar System Viewer +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="solarsystem.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Solar System Viewer</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +This tool displays a model of our solar system as seen from +above. The Sun is drawn as a yellow dot in the center of the +plot, and the orbits of the planets are drawn as ellipses with +the correct shapes and orientations. The current position +of each planet along its orbit is drawn as a colored dot, along +with a name label. The display can be zoomed in and out with +the <keycap>+</keycap> and <keycap>-</keycap> keys, and the +display can be recentered with the arrow keys, or by +double-clicking anywhere in the window with the mouse. You can +also center on a planet with the <keycap>0–9</keycap> keys +(<keycap>0</keycap> is the Sun; <keycap>9</keycap> is Pluto). +If you center on a planet, it will be tracked as time passes in +the tool. +</para> +<para> +The Solar System Viewer has its own clock, independent of the +clock in the main &kstars; window. There is a timestep control +widget here, similar to the one in the main window's toolbar. +However, this control defaults to a timestep of 1 day (so that +the motions of the planets can be seen), and it starts out with +the clock paused when the tool is opened. +</para> +<note> +<para> +The current model used for Pluto's orbit is only good for dates +within about 100 years of the present date. If you let the Solar +System clock advance beyond this range, you will see Pluto behave +very strangely! We are aware of this issue, and will try to +improve Pluto's orbit model soon. +</para> +</note> +</sect1> diff --git a/doc/kstars/solarsystem.png b/doc/kstars/solarsystem.png Binary files differnew file mode 100644 index 00000000..3b4d37cb --- /dev/null +++ b/doc/kstars/solarsystem.png diff --git a/doc/kstars/spiralgalaxies.docbook b/doc/kstars/spiralgalaxies.docbook new file mode 100644 index 00000000..01bcf1a8 --- /dev/null +++ b/doc/kstars/spiralgalaxies.docbook @@ -0,0 +1,91 @@ +<sect1 id="ai-spiralgal"> + +<sect1info> +<author> +<firstname>Mike</firstname> +<surname>Choatie</surname> +</author> +</sect1info> + +<title>Spiral Galaxies</title> +<indexterm><primary>Spiral Galaxies</primary> +</indexterm> + +<para> +Spiral galaxies are huge collections of billions of stars, most of +which are flattened into a disk shape, with a bright, spherical bulge +of stars at its center. Within the disk, there are +typically bright arms where the youngest, brightest stars are +found. These arms wind out from the center in a spiral pattern, giving +the galaxies their name. Spiral galaxies look a bit like hurricanes, +or like water flowing down a drain. They are some of the most beautiful +objects in the sky. +</para> +<para> +Galaxies are classified using a <quote>tuning fork diagram</quote>. +The end of the fork classifies <link linkend="ai-ellipgal">elliptical +galaxies</link> on a scale from the roundest, which is an E0, to +those that appear most flattened, which is rated as E7. The +<quote>tines</quote> of the tuning fork are where the two types of +spiral galaxies are classified: normal spirals, and +<quote>barred</quote> spirals. A barred spiral is one whose nuclear +bulge is stretched out into a line, so it literally looks like it has +a <quote>bar</quote> of stars in its center. +</para><para> +Both types of spiral galaxies are sub-classified according to the +prominence of their central <quote>bulge</quote> of stars, their overall +surface brightness, and how tightly their spiral arms are wound. These +characteristics are related, so that an Sa galaxy has a large central bulge, +a high surface brightness, and tightly-wound spiral arms. An Sb galaxy +has a smaller bulge, a dimmer disk, and looser arms than an Sa, and so on +through Sc and Sd. Barred galaxies use the same classification scheme, +indicated by types SBa, SBb, SBc, and SBd. +</para><para> +There is another class of galaxy called S0, which is morphologically a +transitional type between true spirals and ellipticals. Its spiral arms are +so tightly wound as to be indistinguishable; S0 galaxies have disks with a +uniform brightness. They also have an extremely dominant bulge. +</para><para> +The Milky Way galaxy, which is home to earth and all of the stars in our +sky, is a Spiral Galaxy, and is believed to be a barred spiral. The name +<quote>Milky Way</quote> refers to a band of very faint stars in the sky. +This band is the result of looking in the plane of our galaxy's disk from +our perspective inside it. +</para><para> +Spiral galaxies are very dynamic entities. They are hotbeds of star +formation, and contain many young stars in their disks. Their central +bulges tend to be made of older stars, and their diffuse halos are +made of the very oldest stars in the Universe. Star formation is active +in the disks because that is where the gas and dust are most concentrated; +gas and dust are the building blocks of star formation. +</para><para> +Modern telescopes have revealed that many Spiral galaxies harbor +supermassive black holes at their centers, with masses that can exceed +that of a billion Suns. Both elliptical and spiral galaxies are known +to contain these exotic objects; in fact many astronomers now believe +that <emphasis>all</emphasis> large galaxies contain a supermassive +black hole in their nucleus. Our own Milky Way is known to harbor +a black hole in its core with a mass millions of times bigger than a +star's mass. +</para> + +<tip> +<para> +There are many fine examples of spiral galaxies to be found in +&kstars;, and many have beautiful images available in their +<link linkend="popup-menu">popup menu</link>. You can find them +by using the <link linkend="findobjects">Find Object</link> window. +Here is a list of some spiral galaxies with nice images available: +<itemizedlist> +<listitem><para>M 64, the Black-Eye Galaxy (type Sa)</para></listitem> +<listitem><para>M 31, the Andromeda Galaxy (type Sb)</para></listitem> +<listitem><para>M 81, Bode's Galaxy (type Sb)</para></listitem> +<listitem><para>M 51, the Whirlpool Galaxy (type Sc)</para></listitem> +<listitem><para>NGC 300 (type Sd) [use DSS image link]</para></listitem> +<listitem><para>M 83 (type SBa)</para></listitem> +<listitem><para>NGC 1530 (type SBb)</para></listitem> +<listitem><para>NGC 1073 (type SBc)</para></listitem> +</itemizedlist> +</para> +</tip> +</sect1> diff --git a/doc/kstars/star_colors.png b/doc/kstars/star_colors.png Binary files differnew file mode 100644 index 00000000..f017e3ed --- /dev/null +++ b/doc/kstars/star_colors.png diff --git a/doc/kstars/stars.docbook b/doc/kstars/stars.docbook new file mode 100644 index 00000000..777a636c --- /dev/null +++ b/doc/kstars/stars.docbook @@ -0,0 +1,134 @@ +<sect1 id="ai-stars"> +<sect1info> +<author> +<firstname>Jason</firstname> <surname>Harris</surname> +</author> +</sect1info> +<title>Stars: An Introductory <acronym>FAQ</acronym></title> +<indexterm><primary>Stars</primary></indexterm> + +<qandaset id="stars-faq"> + +<qandaentry> +<question> +<para>What are the stars?</para> +</question> +<answer> +<para> +<firstterm>Stars</firstterm> are gigantic, self-gravitating spheres +of (mostly) Hydrogen gas. Stars are also thermonuclear engines; +nuclear fusion takes place deep in the cores of stars, where the +density is extreme and the temperature reaches tens of millions +of degrees Celsius. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is the Sun a star?</para> +</question> +<answer> +<para> +Yes, the Sun is a star. It is the dominant centerpiece of our +solar system. Compared to other stars, our Sun is rather ordinary; +it appears to be so much bigger and brighter to us +because it is millions of times closer than any other star. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why do stars shine?</para> +</question> +<answer> +<para> +The short answer is: star shine because they are very hot. It is +really no more complicated than that. Any object heated to +thousands of degrees will radiate light, just like stars do. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>The obvious next question is: why are stars so hot?</para> +</question> +<answer> +<para> +This is a tougher question. The usual answer is that stars get +their heat from the thermonuclear fusion reactions in their cores. +However, this cannot be the ultimate cause for the stars' heat, +because a star must be hot in the first place for nuclear fusion to be +triggered. Fusion can only sustain the hot temperature; it cannot +make a star hot. A more correct answer is that stars are hot because +they have collapsed. Stars form from diffuse gaseous nebulae; as the +nebulous gas condenses to form a star, the gravitational potential +energy of the material is released, first as kinetic energy, and +ultimately as heat as the density increases. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Are stars all the same?</para> +</question> +<answer> +<para> +Stars have many things in common: they are all collapsed spheres of +hot, dense gas (mostly Hydrogen), and nuclear fusion reactions are +occurring at or near the centers of every star in the sky. +</para><para> +However, stars also show a great diversity in some properties. +The brightest stars shine almost 100 million times as brightly as the +faintest stars. Stars range in surface temperature from only a few +thousand degrees to almost 50,000 degrees Celsius. These differences +are largely due to differences in mass: massive stars are both hotter +and brighter than lower-mass stars. The temperature and Luminosity +also +depend on the <emphasis>evolutionary state</emphasis> +of the star. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What is the Main Sequence?</para> +</question> +<answer> +<para><indexterm><primary>Main sequence</primary></indexterm> +The main sequence is the evolutionary state of a star when it is +fusing Hydrogen in its core. This is the first (and longest) stage +of a star's life (not including protostar phases). What happens to a +star after it runs out of core Hydrogen is addressed in the stellar +evolution article (coming soon). +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How long do stars last?</para> +</question> +<answer> +<para> +The lifetime of a star depends very much on its mass. More massive +stars are hotter and shine much more brightly, causing them to +consume their nuclear fuel much more rapidly. The largest +stars (roughly 100 times as massive as the Sun), will run out of +fuel in only a few million years; while the smallest stars (roughly +ten percent the mass of the Sun), with their much more frugal +consumption rate, will shine on (albeit dimly) for +<emphasis>trillions</emphasis> of years. Note that this is much +longer than the Universe has yet been in existence. +</para> +</answer> +</qandaentry> + +</qandaset> +</sect1> + + diff --git a/doc/kstars/timezones.docbook b/doc/kstars/timezones.docbook new file mode 100644 index 00000000..6f20ef9d --- /dev/null +++ b/doc/kstars/timezones.docbook @@ -0,0 +1,44 @@ +<sect1 id="ai-timezones"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>Time Zones</title> +<indexterm><primary>Time Zones</primary> +</indexterm> +<para> +The Earth is round, and it is always half-illuminated by the Sun. However, +because the Earth is spinning, the half that is illuminated is always changing. +We experience this as the passing of days wherever we are on the Earth's +surface. At any given instant, there are places on the Earth passing from the +dark half into the illuminated half (which is seen as <emphasis>dawn</emphasis> +on the surface). At the same instant, on the opposite side of the Earth, points +are passing from the illuminated half into darkness (which is seen as +<emphasis>dusk</emphasis> at those locations). So, at any given time, different +places on Earth are experiencing different parts of the day. Thus, Solar time +is defined locally, so that the clock time at any location describes the part of +the day consistently. +</para><para> +This localization of time is accomplished by dividing the globe into 24 vertical +slices called <firstterm>Time Zones</firstterm>. The Local Time is the same +within any given zone, but the time in each zone is one Hour +<emphasis>earlier</emphasis> than the time in the neighboring Zone to the East. +Actually, this is a idealized simplification; real Time Zone boundaries are not +straight vertical lines, because they often follow national boundaries and other +political considerations. +</para><para> +Note that because the Local Time always increases by an hour when moving between +Zones to the East, by the time you move through all 24 Time Zones, you are a +full day ahead of where you started. We deal with this paradox by defining the +<firstterm>International Date Line</firstterm>, which is a Time Zone boundary in +the Pacific Ocean, between Asia and North America. Points just to the East of +this line are 24 hours behind the points just to the West of the line. This +leads to some interesting phenomena. A direct flight from Australia to +California arrives before it departs. Also, the islands of Fiji straddle the +International Date Line, so if you have a bad day on the West side of Fiji, you +can go over to the East side of Fiji and have a chance to live the same day all +over again. +</para> +</sect1> diff --git a/doc/kstars/tools.docbook b/doc/kstars/tools.docbook new file mode 100644 index 00000000..ec4eda21 --- /dev/null +++ b/doc/kstars/tools.docbook @@ -0,0 +1,33 @@ +<chapter id="tools"> +<title>KStars Tools</title> +<para> +<indexterm><primary>Tools</primary></indexterm> +&kstars; comes with a number of tools that allow you to explore +some more advanced aspects of astronomy and the night sky. +</para> + +<itemizedlist> +<listitem><para><link linkend="tool-details">Object Details</link></para></listitem> +<listitem><para><link linkend="tool-calculator">Astrocalculator</link></para></listitem> +<listitem><para><link linkend="tool-aavso">AAVSO Lightcurves</link></para></listitem> +<listitem><para><link linkend="tool-altvstime">Altitude vs. Time Plotter</link></para></listitem> +<listitem><para><link linkend="tool-whatsup">What's Up Tonight?</link></para></listitem> +<listitem><para><link linkend="tool-scriptbuilder">Script Builder</link></para></listitem> +<listitem><para><link linkend="tool-solarsys">Solar System Viewer</link></para></listitem> +<listitem><para><link linkend="tool-jmoons">Jupiter Moons Tool</link></para></listitem> +<listitem><para><link linkend="tool-observinglist">Observing List Tool</link></para></listitem> +<listitem><para><link linkend="tool-fitsviewer">FITS Viewer</link></para></listitem> +</itemizedlist> + +&tool-details; +&tool-calculator; +&tool-aavso; +&tool-altvstime; +&tool-whatsup; +&tool-scriptbuilder; +&tool-solarsys; +&tool-jmoons; +&tool-observinglist; +&tool-fitsviewer; + +</chapter> diff --git a/doc/kstars/utime.docbook b/doc/kstars/utime.docbook new file mode 100644 index 00000000..c8c47375 --- /dev/null +++ b/doc/kstars/utime.docbook @@ -0,0 +1,49 @@ +<sect1 id="ai-utime"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>Universal Time</title> +<indexterm><primary>Universal Time</primary> +<seealso>Time Zones</seealso> +</indexterm> +<para> +The time on our clocks is essentially a measurement of the current position of +the Sun in the sky, which is different for places at different Longitudes +because the Earth is round (see <link linkend="ai-timezones">Time Zones</link>). +</para><para> +However, it is sometimes necessary to define a global time, one that is the same +for all places on Earth. One way to do this is to pick a place on the Earth, +and adopt the Local Time at that place as the <firstterm>Universal +Time</firstterm>, abbreviated <abbrev>UT</abbrev>. (The name is a bit of a +misnomer, since Universal Time has little to do with the Universe. It would +perhaps be better to think of it as <emphasis>global time</emphasis>). +</para><para> +The geographic location chosen to represent Universal Time is Greenwich, +England. The choice is arbitrary and historical. Universal Time became an +important concept when European ships began to sail the wide open seas, far from +any known landmarks. A navigator could reckon the ship's longitude by comparing +the Local Time (as measured from the Sun's position) to the time back at the +home port (as kept by an accurate clock on board the ship). Greenwich was home +to England's Royal Observatory, which was charged with keeping time +very accurately, so that ships in port could re-calibrate their clocks before +setting sail. +</para> +<tip> +<para>Exercise:</para> +<para> +Set the geographic location to <quote>Greenwich, England</quote> using the +<guilabel>Set Location</guilabel> window +(<keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo>). Note that the +Local Time (<abbrev>LT</abbrev>)and the Universal Time (<abbrev>UT</abbrev>) are +now the same. +</para><para> +Further Reading: The history behind the construction of the first clock +that was accurate and stable enough to be used on ships to keep Universal Time +is a fascinating tale, and one told expertly in the book +<quote>Longitude</quote>, by Dava Sobel. +</para> +</tip> +</sect1> diff --git a/doc/kstars/viewops.png b/doc/kstars/viewops.png Binary files differnew file mode 100644 index 00000000..bfc6d375 --- /dev/null +++ b/doc/kstars/viewops.png diff --git a/doc/kstars/wut.docbook b/doc/kstars/wut.docbook new file mode 100644 index 00000000..90c03c60 --- /dev/null +++ b/doc/kstars/wut.docbook @@ -0,0 +1,58 @@ +<sect1 id="tool-whatsup"> +<title>What's Up Tonight? Tool</title> +<indexterm><primary>Tools</primary> +<secondary>What's Up Tonight? Tool</secondary> +</indexterm> + +<screenshot> +<screeninfo> +The What's Up Tonight Tool +</screeninfo> +<mediaobject> + <imageobject> + <imagedata fileref="wut.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>What's Up Tonight?</phrase> + </textobject> +</mediaobject> +</screenshot> + +<para> +The <quote>What's Up Tonight?</quote> (WUT) tool displays a list of +objects that will be visible at night from any location, on any date. +By default, the Date and Location are taken from the current settings +in the main window, but you can change either value using the +<guibutton>Change Date</guibutton> and <guibutton>Change +Location</guibutton> buttons at the top of the WUT window. +</para> +<para> +The WUT tool also displays a short almanac of data for the selected +date: the rise and set times for the Sun and moon, the duration of +the night, and the Moon's illumination fraction. +</para> +<para> +Below the almanac is where the object information is displayed. The +objects are organized into type categories. Select an object type +in the box labeled <guilabel>Choose a Category</guilabel>, and all +objects of that type which are above the horizon on the selected +night will be displayed in the box labeled <guilabel>Matching +Objects</guilabel>. For example, in the screenshot, the +<guilabel>Planets</guilabel> category has been selected, and four +planets which are up on the selected night are displayed (Mars, +Neptune, Pluto, and Uranus). When an object in the list is selected, +its rise, set and transit times are displayed in the lower-right +panel. In addition, you can press the <guibutton>Object +Details...</guibutton> button to open the <link +linkend="tool-details">Object Details window</link> for that +object. +</para> +<para> +By default, the WUT will display objects which are above the horizon +between sunset and midnight (i.e., <quote>in the evening</quote>). +You can choose to show objects which are up between midnight and dawn +(<quote>in the morning</quote>), or between dusk and dawn (<quote>any +time tonight</quote>) using the combobox near the top of the window. +</para> +</sect1> + diff --git a/doc/kstars/wut.png b/doc/kstars/wut.png Binary files differnew file mode 100644 index 00000000..a65a10f2 --- /dev/null +++ b/doc/kstars/wut.png diff --git a/doc/kstars/zenith.docbook b/doc/kstars/zenith.docbook new file mode 100644 index 00000000..f0d80ea2 --- /dev/null +++ b/doc/kstars/zenith.docbook @@ -0,0 +1,31 @@ +<sect1 id="ai-zenith"> +<sect1info> +<author> +<firstname>Jason</firstname> +<surname>Harris</surname> +</author> +</sect1info> +<title>The Zenith</title> +<indexterm><primary>Zenith</primary> +<seealso>Horizontal Coordinates</seealso> +</indexterm> +<para> +The Zenith is the point in the sky where you are looking when you look +<quote>straight up</quote> from the ground. More precisely, it is the point on +the sky with an <firstterm>Altitude</firstterm> of +90 Degrees; it is the Pole +of the <link linkend="horizontal">Horizontal Coordinate +System</link>. Geometrically, it is the point on the <link +linkend="ai-csphere">Celestial Sphere</link> intersected by a line drawn from +the center of the Earth through your location on the Earth's surface. +</para><para> +The Zenith is, by definition, a point along the <link +linkend="ai-meridian">Local Meridian</link>. +</para> +<tip> +<para>Exercise:</para> +<para> +You can point to the Zenith by pressing <keycap>Z</keycap> or by selecting +<guimenuitem>Zenith</guimenuitem> from the <guimenu>Pointing</guimenu> menu. +</para> +</tip> +</sect1> |
