Commit bcbf22f1 authored by langurmonkey's avatar langurmonkey

Migrating to rst

parent 2cb39c8d
This diff is collapsed.
This diff is collapsed.
Welcome to the Gaia Sky wiki!
*****************************
.. figure:: https://zah.uni-heidelberg.de/fileadmin/user_upload/gaia/gaiasky/img/GaiaSkySplash-s.jpg
:alt: Gaia Sky logo
Gaia Sky logo
|Build status|
**Gaia Sky just hit version 1.0.0!**
**Gaia Sky** is a real-time, 3D, astronomy visualisation software that
runs on Windows, Linux and MacOS. It lives in the framework of
`ESA <http://www.esa.int/ESA>`__'s `Gaia
mission <http://sci.esa.int/gaia>`__ to chart about 1 billion stars of
our Milky Way Galaxy. It is developed in the Gaia group of the
`Astronomisches Rechen-Institut <www.ari.uni-heidelberg.de>`__
(`ZAH <www.zah.uni-heidelberg.de>`__, `Universität
Heidelberg <www.uni-heidelberg.de>`__).
- Official site:
`GaiaSky@ARI <http://www.zah.uni-heidelberg.de/gaia2/outreach/gaiasky/>`__
- Product page: `Gaia Sky <http://ari-zah.github.io/gaiasky>`__
- Wiki: `You are in it! <https://github.com/ari-zah/gaiasky/wiki/>`__
.. |Build status| image:: https://circleci.com/gh/ari-zah/gaiasky/tree/master.svg?style=svg
:target: https://circleci.com/gh/ari-zah/gaiasky/tree/master
Installation and uninstallation
*******************************
Depending on your system and your personal preferences the installation
procedure may vary. Below is a description of the various installation methods
available.
You can download all packages [here](https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/).
### Windows
Two windows installers are available for 32 and 64-bit systems. Get them [here](https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/).
- `gaiasky_windows_<version>.exe` - 32 bit installer.
- `gaiasky_windows-x64_<version>.exe` - 64 bit installer.
To install the Gaia Sky, just double click on the installer and
then follow the on-screen instructions. You will need to choose the
directory where the application is to be installed.
In order to **uninstall** the application you can use the Windows Control Panel or
you can use the provided uninstaller in the Gaia Sky folder.
### Linux
We provide 3 packages for linux systems (`deb` for *Debian*, *Ubuntu* and derivatives, `rpm` for *RedHat*, *Fedora* and derivatives and a linux installer which works on all distros) plus an [`AUR` package](https://aur.archlinux.org/packages/gaiasky/) for *Arch* and derivatives.
Get the packages [here](https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/).
#### deb
This is the package for Debian-based distros (*Debian*, *Ubuntu*, *Mint*, *SteamOS*, etc.).
[Download](https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/) the `gaiasky_<version>.deb` file and run the
following command. You will need root privileges to install a `deb` package in
your system.
```
sudo dpkg -i gaiasky_<version>.deb
```
This will install the application in the `/opt/gaiasky/` folder
and it will create the necessary shortcuts and `.desktop` files. The package depends on
the `default-jre` package, which will be installed if it is not yet there.
In order to **uninstall**, just type:
```
sudo apt-get remove gaiasky
```
#### rpm
This is the package for RPM-based distributions (*Red Hat*, *Fedora*, *Mandriva*, *SUSE*, *CentOS*, etc.)
[Download](https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/) the `gaiasky_linux_<version>.rpm` file and run the
following command. You will need root privileges to install a `rpm` package in
your system.
```
sudo yum install gaiasky_linux_<version>.rpm
```
This will install the application in the `/opt/gaiasky/` folder
and it will create the necessary shortcuts.
In order to **uninstall**, just type:
```
sudo yum remove gaiasky-x86
```
#### Install from AUR
If you have *Arch*, *Manjaro*, *Antergos* or any other Arch Linux derivative, you can install the [package from AUR](https://aur.archlinux.org/packages/gaiasky/) using any tool able to install AUR software.
For example:
```
sudo yauort -S gaiasky
```
This will download the package and install it in your system. Fast and easy.
#### Unix/Linux installer
We also provide a [Unix/Linux installer](https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/) that will trigger a graphical interface
where you can choose the installation location and some other settings.
Download the file `gaiasky_unix_<version>.sh` to your disk.
Then run the following to start the installation.
```
./gaiasky_unix_[version].sh
```
Follow the on-screen instructions to proceed with the installation.
In order to **uninstall**, just execute the `uninstall` file in the
installation folder.
### OS X - Mac
For OS X we provide a `gaiasky_macos_<version>.dmg` file [here](https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/),
which is installed by unpacking into the Applications folder. Once unpacked, the
installer will come up, you just need to follow its instructions.
### Compressed (TGZ) package
A `gaiasky-[version].tgz` package file is also provided [here](https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/). It will work
in all systems but you need to unpack it yourself and create the desired
shortcuts.
In **Windows**, use an archiver software (7zip, iZArc, etc.) to unpack it.
In **Linux** and **OS X**, you can use:
```
tar zxvf gaiasky-<version>.tgz
```
Requirements and Installation
*****************************
In the sections below is the information on the minimum hardware requirements and on how to install the software.
* [[System requirements]]
* [[Installation and uninstallation]]
* [[Running from source|Running-from-source]]
Requirements and Installation
=============================
--------------
In the sections below is the information on the minimum hardware
requirements and on how to install the software.
System requirements
-------------------
Here are the minimum requirements to run this software:
+------------------------+----------------------------------------------------------------------------------+
| **Operating system** | Windows 7+ / MacOS X / Linux |
+========================+==================================================================================+
| **CPU** | Intel Core i3 3rd Generation or similar |
+------------------------+----------------------------------------------------------------------------------+
| **GPU** | OpenGL 3.0 support / Intel HD 4000 / Nvidia GeForce 8400 GS |
+------------------------+----------------------------------------------------------------------------------+
| **Memory** | 4 GB RAM |
+------------------------+----------------------------------------------------------------------------------+
| **Hard drive** | 150 MB of free space |
+------------------------+----------------------------------------------------------------------------------+
| **Java** | On Linux, you need the Java Runtime Environment 7+ installed (openJRE is fine) |
+------------------------+----------------------------------------------------------------------------------+
Installation and uninstallation
-------------------------------
Depending on your system and your personal preferences the installation
procedure may vary. Below is a description of the various installation
methods available. You can download all packages
`here <https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/>`__.
Windows
~~~~~~~
Two windows installers are available for 32 and 64-bit systems. Get them
`here <https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/>`__.
- ``gaiasky_windows_<version>.exe`` - 32 bit installer.
- ``gaiasky_windows-x64_<version>.exe`` - 64 bit installer.
To install the Gaia Sky, just double click on the installer and then
follow the on-screen instructions. You will need to choose the directory
where the application is to be installed.
In order to **uninstall** the application you can use the Windows
Control Panel or you can use the provided uninstaller in the Gaia Sky
folder.
Linux
~~~~~
We provide 3 packages for linux systems (``deb`` for *Debian*, *Ubuntu*
and derivatives, ``rpm`` for *RedHat*, *Fedora* and derivatives and a
linux installer which works on all distros) plus an ```AUR``
package <https://aur.archlinux.org/packages/gaiasky/>`__ for *Arch* and
derivatives. Get the packages
`here <https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/>`__.
deb
^^^
This is the package for Debian-based distros (*Debian*, *Ubuntu*,
*Mint*, *SteamOS*, etc.).
`Download <https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/>`__
the ``gaiasky_<version>.deb`` file and run the following command. You
will need root privileges to install a ``deb`` package in your system.
::
sudo dpkg -i gaiasky_<version>.deb
This will install the application in the ``/opt/gaiasky/`` folder and it
will create the necessary shortcuts and ``.desktop`` files. The package
depends on the ``default-jre`` package, which will be installed if it is
not yet there.
In order to **uninstall**, just type:
::
sudo apt-get remove gaiasky
rpm
^^^
This is the package for RPM-based distributions (*Red Hat*, *Fedora*,
*Mandriva*, *SUSE*, *CentOS*, etc.)
`Download <https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/>`__
the ``gaiasky_linux_<version>.rpm`` file and run the following command.
You will need root privileges to install a ``rpm`` package in your
system.
::
sudo yum install gaiasky_linux_<version>.rpm
This will install the application in the ``/opt/gaiasky/`` folder and it
will create the necessary shortcuts.
In order to **uninstall**, just type:
::
sudo yum remove gaiasky-x86
Install from AUR
^^^^^^^^^^^^^^^^
If you have *Arch*, *Manjaro*, *Antergos* or any other Arch Linux
derivative, you can install the `package from
AUR <https://aur.archlinux.org/packages/gaiasky/>`__ using any tool able
to install AUR software. For example:
::
sudo yauort -S gaiasky
This will download the package and install it in your system. Fast and
easy.
Unix/Linux installer
^^^^^^^^^^^^^^^^^^^^
We also provide a `Unix/Linux
installer <https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/>`__
that will trigger a graphical interface where you can choose the
installation location and some other settings. Download the file
``gaiasky_unix_<version>.sh`` to your disk. Then run the following to
start the installation.
::
./gaiasky_unix_[version].sh
Follow the on-screen instructions to proceed with the installation.
In order to **uninstall**, just execute the ``uninstall`` file in the
installation folder.
OS X - Mac
~~~~~~~~~~
For OS X we provide a ``gaiasky_macos_<version>.dmg`` file
`here <https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/>`__,
which is installed by unpacking into the Applications folder. Once
unpacked, the installer will come up, you just need to follow its
instructions.
Compressed (TGZ) package
~~~~~~~~~~~~~~~~~~~~~~~~
A ``gaiasky-[version].tgz`` package file is also provided
`here <https://zah.uni-heidelberg.de/gaia/outreach/gaiasky/downloads/>`__.
It will work in all systems but you need to unpack it yourself and
create the desired shortcuts. In **Windows**, use an archiver software
(7zip, iZArc, etc.) to unpack it.
In **Linux** and **OS X**, you can use:
::
tar zxvf gaiasky-<version>.tgz
Running from source
-------------------
Requirements
~~~~~~~~~~~~
If you want to compile the source code, you will need the following:
- `JDK7 or
above <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`__
(JDK8 recommended)
Please, be aware that only ``tags`` are guaranteed to work
(`here <https://github.com/ari-zah/gaiasky/tags>`__). The ``master``
branch holds the development version and the configuration files are
possibly messed up and not ready to work out-of-the-box. So remember to
use a ``tag`` version if you want to run it right away from source.
Also, this guide is for **Unix-like systems only**. If you are working
on Windows, you will need `git for
windows <http://git-scm.com/download/win>`__ and `Power
Shell <http://en.wikipedia.org/wiki/Windows_PowerShell>`__, even though
it has not been tested.
First, clone the repository:
::
git clone https://github.com/ari-zah/gaiasky.git
cd gaiasky
Compile and run
~~~~~~~~~~~~~~~
To compile the code and run the desktop version of the application:
::
gradlew desktop:run
Package the Gaia Sky
~~~~~~~~~~~~~~~~~~~~
To pack the application into a ``tar`` file:
::
gradlew desktop:createTar
In order to produce the desktop installers for the various systems you
need a licensed version of ``Install4j``.
::
gradlew desktop:pack
These commands will compile and package the application into a
``gaiasky-[version]`` folder under the ``gaiasky/releases`` folder.
In order to run the program follow the instructions of your operating
system.
### Linux
In order to run the application on Linux, open the terminal, uncompress the archive,
give execution permissions to the `run.sh` file and then run it.
```
tar zxvf gaiasandbox-[version].tgz
cd gaiasandbox-[version]/
gaiasandbox
```
Alternatively you can run the jar file directly, specifying the configuration
file.
```
java -Dproperties.file=conf/global.properties -jar gaiasandbox.jar
```
### Windows
In order to run the application on Windows, open a terminal window (type
`cmd` in the start menu search box) and run the `run.bat` file.
```
cd path_to_gaiasandbox_folder
gaiasandbox.bat
```
Alternatively you can run the jar file directly, specifying the configuration
file.
```
java -Dproperties.file=conf/global.properties -jar gaiasandbox.jar
```
### OS X
To run the application on MacOS systems, follow the instructions in the
[Linux](#linux) section.
Running from source
*******************
### Requirements
If you want to compile the source code, you will need the following:
- [JDK7 or above](http://www.oracle.com/technetwork/java/javase/downloads/index.html) (JDK8 recommended)
Please, be aware that only `tags` are guaranteed to work ([here](https://github.com/ari-zah/gaiasky/tags)). The `master` branch holds the development version and the configuration files are possibly messed up and not ready to work out-of-the-box. So remember to use a `tag` version if you want to run it right away from source.
Also, this guide is for **Unix-like systems only**. If you are working
on Windows, you will need [git for windows](http://git-scm.com/download/win) and [Power Shell](http://en.wikipedia.org/wiki/Windows_PowerShell), even though it has not been tested.
First, clone the repository:
```
git clone https://github.com/ari-zah/gaiasky.git
cd gaiasky
```
### Compile and run
To compile the code and run the desktop version of the application:
```
gradlew desktop:run
```
### Package the Gaia Sky
To pack the application into a ``tar`` file:
```
gradlew desktop:createTar
```
In order to produce the desktop installers for the various systems you need a licensed version of ``Install4j``.
```
gradlew desktop:pack
```
These commands will compile and package the application into a
`gaiasky-[version]` folder under the `gaiasky/releases`
folder.
If you installed the software using an installer or a package manager system (`rpm`, `deb`), you just need to use the standard running procedures of your Operating System to run the application.
### Windows
In windows, this means clicking on `Start` and then browsing the start menu folder `Gaia Sandbox`. You can run the executable from there.
### Linux
Just type `gaiasandbox` in a terminal or use your favourite desktop environment search engine to run the Gaia Sandbox launcher.
### OS X
Locate the launcher using the main search.
### Code and pakcage
However, if you are a maverick and do not like installers, you can also run the Gaia Sandbox directly from the source code in `GitHub` or using the `tgz` package.
* [[Running from source]]
* [[Running from downloaded package]]
Running the software
*******************
If you installed the software using an installer or a package manager
system (``rpm``, ``deb``), you just need to use the standard running
procedures of your Operating System to run the application.
**Windows**
In windows, this means clicking on ``Start`` and then browsing the start
menu folder ``Gaia Sandbox``. You can run the executable from there.
**Linux**
Just type ``gaiasandbox`` in a terminal or use your favourite desktop
environment search engine to run the Gaia Sandbox launcher.
**OS X**
Locate the launcher using the main search.
**Code and pakcage**
However, if you are a maverick and do not like installers, you can also
run the Gaia Sandbox directly from the source code in ``GitHub`` or
using the ``tgz`` package.
Running from source
===================
Requirements
------------
If you want to compile the source code, you will need the following:
- `JDK7 or
above <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`__
(JDK8 recommended)
Please, be aware that only ``tags`` are guaranteed to work
(`here <https://github.com/ari-zah/gaiasky/tags>`__). The ``master``
branch holds the development version and the configuration files are
possibly messed up and not ready to work out-of-the-box. So remember to
use a ``tag`` version if you want to run it right away from source.
Also, this guide is for **Unix-like systems only**. If you are working
on Windows, you will need `git for
windows <http://git-scm.com/download/win>`__ and `Power
Shell <http://en.wikipedia.org/wiki/Windows_PowerShell>`__, even though
it has not been tested.
First, clone the repository:
::
git clone https://github.com/ari-zah/gaiasky.git
cd gaiasky
Compile and run
---------------
To compile the code and run the desktop version of the application:
::
gradlew desktop:run
Package the Gaia Sky
--------------------
To pack the application into a ``tar`` file:
::
gradlew desktop:createTar
In order to produce the desktop installers for the various systems you
need a licensed version of ``Install4j``.
::
gradlew desktop:pack
These commands will compile and package the application into a
``gaiasky-[version]`` folder under the ``gaiasky/releases`` folder.
Running from downloaded package
===============================
In order to run the program follow the instructions of your operating
system.
Linux
-----
In order to run the application on Linux, open the terminal, uncompress
the archive, give execution permissions to the ``run.sh`` file and then
run it.
::
tar zxvf gaiasandbox-[version].tgz
cd gaiasandbox-[version]/
gaiasandbox
Alternatively you can run the jar file directly, specifying the
configuration file.
::
java -Dproperties.file=conf/global.properties -jar gaiasandbox.jar
Windows
-------
In order to run the application on Windows, open a terminal window (type
``cmd`` in the start menu search box) and run the ``run.bat`` file.
::
cd path_to_gaiasandbox_folder
gaiasandbox.bat
Alternatively you can run the jar file directly, specifying the
configuration file.
::
java -Dproperties.file=conf/global.properties -jar gaiasandbox.jar
OS X
----
To run the application on MacOS systems, follow the instructions in the
`Linux <#linux>`__ section.
System requirements
*******************
Here are the minimum requirements to run this software:
| **Operating system** | Windows 7+ / MacOS X / Linux |
| :---: | :--- |
| **CPU** | Intel Core i3 3rd Generation or similar |
| **GPU** | OpenGL 3.0 support / Intel HD 4000 / Nvidia GeForce 8400 GS |
| **Memory** | 4 GB RAM |
| **Hard drive** | 150 MB of free space |
| **Java** | On Linux, you need the Java Runtime Environment 7+ installed (openJRE is fine) |
......@@ -38,7 +38,7 @@ templates_path = ['_templates']
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.md'
source_suffix = '.rst'
# The encoding of source files.
#
......
Welcome to the Gaia Sky wiki!
*****************************
![Gaia Sky logo](https://zah.uni-heidelberg.de/fileadmin/user_upload/gaia/gaiasky/img/GaiaSkySplash-s.jpg)
[![Build status](https://circleci.com/gh/ari-zah/gaiasky/tree/master.svg?style=svg)](https://circleci.com/gh/ari-zah/gaiasky/tree/master)
**Gaia Sky just hit version 1.0.0!**
**Gaia Sky** is a real-time, 3D, astronomy visualisation software that
runs on Windows, Linux and MacOS. It lives in the framework of
[ESA](http://www.esa.int/ESA)'s [Gaia mission](http://sci.esa.int/gaia) to chart about 1 billion stars of our Milky Way Galaxy. It is developed in the Gaia group of the [Astronomisches Rechen-Institut](www.ari.uni-heidelberg.de) ([ZAH](www.zah.uni-heidelberg.de), [Universität Heidelberg](www.uni-heidelberg.de)).
* Official site: [GaiaSky@ARI](http://www.zah.uni-heidelberg.de/gaia2/outreach/gaiasky/)
* Product page: [Gaia Sky](http://ari-zah.github.io/gaiasky)
* Wiki: [You are in it!](https://github.com/ari-zah/gaiasky/wiki/)
......@@ -9,10 +9,12 @@ Welcome to Gaia Sky's documentation!
Contents:
.. toctree::
:maxdepth: 2
:maxdepth: 4
home
Home
Requirements
Configuration
Running-the-software
Indices and tables
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment