~registry/stellarium/socis2015-de430

« back to all changes in this revision

Viewing changes to guide/start.tex

  • Committer: georg-zotti
  • Date: 2016-01-16 13:14:07 UTC
  • mfrom: (7721.1.409 trunk)
  • Revision ID: georg.zotti@univie.ac.at-20160116131407-n3yqlhdmlzmc4irj
Merge from trunk r8130; Moved and added tooltips to controls in GUI. Seems ready for merge!

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
\chapterimage{chapter-bg.png} % Chapter heading image
2
 
 
3
 
\chapter{Installation}
4
 
 
5
 
\section{System Requirements}\label{system-requirements}
 
1
% Status info:
 
2
% M. Gates      2006-2009
 
3
% A. Wolf       2011-2015
 
4
% Lee Carré     2011
 
5
% ArdWar        2012
 
6
% MisterE       2013
 
7
% B. Gerdes     2013
 
8
% G. Zotti      2014-2015
 
9
% Additions inserted from wiki 2015-12-26
 
10
% GZ checked grammar and structure, added ANGLE details and Troubleshooting.
 
11
% Content OK for 0.15+.
 
12
 
 
13
 
 
14
\chapter{Getting Started}
 
15
\label{ch:GettingStarted}
 
16
 
 
17
\section{System Requirements}\index{System Requirements}
 
18
\label{sec:GettingStarted:SystemRequirements}
6
19
 
7
20
\subsection{Minimum}
8
21
\begin{itemize}
9
 
\item Linux/Unix; Windows 7 and above\footnote{Since version 0.14.0 only
10
 
  classic application can be work on Windows XP. Version 0.12.4 required
11
 
  Windows 2000 and above}; OS X 10.7.4 and above\footnote{Version 0.12.4
12
 
  required OS X 10.6.8. Version 0.10.6 required OS X 10.5. Version
13
 
  0.10.2 runs on OS X 10.3.9}
14
 
\item 3D graphics card which supports OpenGL 3.0 and GLSL 1.3\footnote{Version
15
 
  0.12.4 required 3D graphics card which supports OpenGL 1.2}
 
22
\item Linux/Unix; Windows 7 and later (It may run on Vista, but unsupported. A special version for XP is still available); OS X 10.7.4 and later
 
23
\item 3D graphics card which supports OpenGL 3.0 and GLSL 1.3
16
24
\item 512 MB RAM
17
25
\item 250 MB free on disk
18
26
\end{itemize}
19
27
 
20
28
\subsection{Recommended}
21
29
\begin{itemize}
22
 
\item Linux/Unix; Windows 7 and above; OS X 10.8.5 and above
23
 
\item 3D graphics card which supports OpenGL 3.3 and above\footnote{Version
24
 
  0.12.4 required 3D graphics card which supports OpenGL 2.1 and above}
 
30
\item Linux/Unix; Windows 7 and later; OS X 10.8.5 and later
 
31
\item 3D graphics card which supports OpenGL 3.3 and above and GLSL1.3 and later
25
32
\item 1 GB RAM or more
26
 
\item 1.5 GB free on disk
 
33
\item 1.5 GB free on disk. (About 3GB extra required for the optional DE431 files.)
27
34
\end{itemize}
28
 
 A dark room for realistic rendering --- details like the Milky Way or
 
35
 A dark room for realistic rendering --- details like the Milky Way, Zodiacal Light or
29
36
star twinkling can't be seen in a bright room.
30
37
 
31
 
\section{Downloading}\label{downloading}
32
 
 
33
 
Download the correct package for your operating system directly from the
34
 
\href{http://stellarium.org}{main page}.
35
 
 
36
 
\section{Installation}\label{installation-stellarium}
37
 
 
38
 
\subsection{Windows}\label{windows}
 
38
\section{Downloading}\index{Downloading}
 
39
\label{sec:GettingStarted:Downloading}
 
40
 
 
41
Download the correct package for your operating system directly from the main page,
 
42
\url{http://stellarium.org}.
 
43
 
 
44
\section{Installation}\index{Installation}
 
45
\label{sec:GettingStarted:Installation}
 
46
 
 
47
\subsection{Windows}\index{Windows}
39
48
 
40
49
\begin{enumerate}
41
 
\item
42
 
  Double click on the \texttt{stellarium-0.14.1-win32.exe} (or
43
 
  \texttt{stellarium-0.14.1-win64.exe} on Windows x64) file to run the
44
 
  installer\footnote{Or \texttt{stellarium-0.14.1-classic-win32.exe} on
45
 
    Windows XP.}.
46
 
\item
47
 
  Follow the on-screen instructions.
 
50
\item Double click on the installer file you downloaded:
 
51
\begin{itemize}
 
52
\item \file{stellarium-\StelVersion-win64.exe}
 
53
\item \file{stellarium-\StelVersion-win32.exe} on Windows x86
 
54
\item \file{stellarium-\StelVersion-classic-win32.exe} for XP
 
55
\end{itemize}
 
56
\item Follow the on-screen instructions.
48
57
\end{enumerate}
49
58
 
50
 
\subsection{MacOS X}\label{macos-x}
 
59
\subsection{OS X}\index{OS X}
51
60
 
52
61
\begin{enumerate}
53
62
\item
54
 
  Locate the Stellarium-0.14.1.dmg\footnote{Or
55
 
    \texttt{Stellarium-0.10.6-PPC.dmg} for PowerPC MacOS X} file in
 
63
  Locate the \file{Stellarium-\StelVersion.dmg} file in
56
64
  Finder and double click on it or open it using the Disk Utility
57
65
  application. Now, a new disk appears on your desktop and Stellarium is
58
66
  in it.
59
67
\item
60
 
  Open the new disk and please take a moment to read the ReadMe file.
61
 
  Then drag Stellarium to the Applications folder.
 
68
  Open the new disk and please take a moment to read the \file{ReadMe} file.
 
69
  Then drag \file{Stellarium} to the Applications folder.
62
70
\item
63
71
  Note: You should copy Stellarium to the Applications folder before
64
72
  running it --- some users have reported problems running it directly
65
 
  from the disk image (.dmg).
 
73
  from the disk image (\file{.dmg}).
66
74
\end{enumerate}
67
75
 
68
 
\subsection{Linux}\label{linux}
 
76
\subsection{Linux}\index{Linux}
69
77
 
70
78
Check if your distribution has a package for Stellarium already --- if
71
79
so you're probably best off using it. If not, you can download and build
72
80
the source.
73
81
 
74
 
For ubuntu we provide a package repository with the latest stable
 
82
For Ubuntu we provide a package repository with the latest stable
75
83
releases. Open a terminal and type:
76
84
 
77
 
\texttt{sudo~add-apt-repository~ppa:stellarium/stellarium-releases}\\
78
 
\texttt{sudo~apt-get~update}\\
79
 
\texttt{sudo~apt-get~install~stellarium}
80
 
 
81
 
\section{Running Stellarium}\label{running-stellarium}
82
 
 
83
 
\begin{itemize}
84
 
\item
85
 
  \textbf{Windows} The Stellarium installer creates an item in the
86
 
  \textbf{Start Menu} under in \textbf{Programs} section. Select this to
87
 
  run \emph{Stellarium}.
88
 
\item
89
 
  \textbf{MacOS X} Double click on the \emph{Stellarium} application.
90
 
  Add it to your \textbf{Dock} for quick access.
91
 
\item
92
 
  \textbf{Linux} If your distribution had a package you'll probably
93
 
  already have an item in the GNOME or KDE application menus. If not,
94
 
  just use a open a terminal and type \texttt{stellarium}.
95
 
\end{itemize}
 
 
b'\\ No newline at end of file'
 
85
\begin{commands}
 
86
sudo add-apt-repository ppa:stellarium/stellarium-releases
 
87
sudo apt-get update
 
88
sudo apt-get install stellarium
 
89
\end{commands}
 
90
 
 
91
 
 
92
\section{Running Stellarium}\index{Running Stellarium}
 
93
\label{sec:GettingStarted:Running}
 
94
 
 
95
\subsection{Windows}\index{Windows}
 
96
\label{sec:GettingStarted:Running:Windows}
 
97
 
 
98
The Stellarium installer creates a whole list of items in the
 
99
\textbf{Start Menu} under the \textbf{Programs/Stellarium}
 
100
section. Select one of these to run Stellarium:
 
101
\begin{description}
 
102
  \item[Stellarium] OpenGL version. This is the most efficient for
 
103
    modern PCs and should be used when you have installed appropriate
 
104
    OpenGL drivers.
 
105
  \item[Stellarium (ANGLE mode)] Uses Direct3D translation of the
 
106
    OpenGL rendering via ANGLE library. Lets the system decide which
 
107
    version of Direct3D is available. In case the system reports
 
108
    support for Direct3D~11 but if you experience odd effects like
 
109
    missing buttons or planets, directly use
 
110
  \item[Stellarium (ANGLE Direct3D 9 mode)] Uses Direct3D translation
 
111
    of the OpenGL rendering via ANGLE library. Forces Direct3D
 
112
    version~9. \emph{This should be used if you don't see buttons or have
 
113
    trouble with other ANGLE modes.}
 
114
  \item[Stellarium (ANGLE Direct3D 11 mode)] Uses Direct3D translation
 
115
    of the OpenGL rendering via ANGLE library. Forces Direct3D
 
116
    version~11. Some systems don't seem to work properly with this.
 
117
  \item[Stellarium (ANGLE WARP mode)] Uses DirectX3D~11 software rendering via ANGLE
 
118
    library. This should work on any PC without dedicated graphics
 
119
    card. However on many systems this fails, it is unclear why.
 
120
  \item[Stellarium (MESA mode)] Uses software rendering via MESA
 
121
    library. This should work on any PC without dedicated graphics
 
122
    card. However on some systems this also fails, it is unclear
 
123
    why\footnote{This was the emergency fallback solution for the 0.13
 
124
      series. We have reports that 0.13.2-MESA works on a system where
 
125
      0.14 does not.}
 
126
\end{description}
 
127
  On startup, a diagnostic check is performed to test whether the
 
128
  graphics hardware is capable of running. If all is fine, you will
 
129
  see nothing of it.  Else you may see an error panel informing you
 
130
  that your computer is not capable of running Stellarium (``No
 
131
  OpenGL~2 found''), or that there is only OpenGL~2.1 support. The
 
132
  latter means you will be able to see some graphics, but depending on
 
133
  the type of issue you will have some bad graphics. For example, on
 
134
  an Intel GMA4500 there is only a minor issue in Night Mode, while on
 
135
  other systems we had reports of missing planets. If you see this,
 
136
  try running in Direct3D~9 or MESA mode, or upgrade your system.
 
137
 
 
138
  When you have found a mode that works on your system, you can delete
 
139
  the other links.
 
140
 
 
141
\subsection{OS X}\index{OS X}
 
142
\label{sec:GettingStarted:Running:MacOSX}
 
143
 
 
144
Double click on the \emph{Stellarium} application.  Add it to your
 
145
\textbf{Dock} for quick access.
 
146
 
 
147
\subsection{Linux}\index{Linux}
 
148
\label{sec:GettingStarted:Running:Linux}
 
149
 
 
150
If your distribution had a package you'll probably already have an
 
151
item in the GNOME or KDE application menus. If not, just use a open a
 
152
terminal and type \texttt{stellarium}.
 
153
 
 
154
 
 
155
\subsection{Troubleshooting}
 
156
\label{sec:GettingStarted:Running:Troubleshooting}
 
157
 
 
158
Stellarium writes startup and other diagnostic messages into a
 
159
logfile. Please see section~\ref{sec:FilesAndDirectories} where this
 
160
file is located on your system. This file is \emph{essential} in case when
 
161
you feel you need to report a problem with your system which has not
 
162
been found before.
 
163
 
 
164
If you don't succeed in running Stellarium, please see the online
 
165
forum\footnote{\url{https://launchpad.net/stellarium}}.  It includes
 
166
FAQ (Frequently Asked Questions)\index{FAQ} and a general question
 
167
section which may include further hints. Please make sure you have
 
168
read and understood the FAQ before asking the same questions again.
 
169
 
 
170
 
 
171
%%% Local Variables: 
 
172
%%% mode: latex
 
173
%%% TeX-PDF-mode: t
 
174
%%% TeX-master: "guide"
 
175
%%% End: