Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MrSinho committed Aug 13, 2023
1 parent 1c86bf6 commit 9238f77
Show file tree
Hide file tree
Showing 27 changed files with 167 additions and 39 deletions.
49 changes: 10 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,23 @@ _Check the linux and windows build logs:_

A static 3d representation of of the Gaia (Early) Data Release 3 Universe Model data uploaded by the European Space Agency.

![](saved/alphafe_age_mass.png)
![](docs/media/alphafe_age_mass.png)

---

## Build status

Programs and libraries are frequently being tested on Windows 11, and Linux Mint (virtual machine and pc) with different compilers (`MSVC`, `gcc`), and hardware configurations (`RX580 4GB GDDR5`, `Radeon V Carrizo 500MB`).
Programs and libraries are frequently being tested on Windows 11, and Linux Mint (wsl and physical machine) with different compilers (`MSVC`, `gcc`), and hardware configurations (`RX580 4GB GDDR5`, `Radeon V Carrizo 500MB`).

![](saved/mass_feh_age_polar__agecf-1.png)
![](docs/media/mass_feh_age_polar__agecf-1.png)

---

## Documentation

* [`Quick install`](docs/quick-install.md)
* [`Clone and build`](docs/clone-and-build.md)
* [`Download universe model data`](docs/download-universe-model-data.md)
* [`Runtime tutorial`](docs/runtime-tutorial.md)
* [`Quick install`](/docs/quick-install.md)
* [`Terminal install`](/docs/terminal-install.md)
* [`Runtime tutorial`](/docs/runtime-tutorial.md)

---

Expand All @@ -35,40 +34,12 @@ Programs and libraries are frequently being tested on Windows 11, and Linux Mint
* Decide what parameters to read (`xyz` parameter types + color_filter). To find what parameters are compatible, see [`settings.smd`](./gaia-universe-model/smd/settings.smd).
* Graphics settings options: view modes (cartesian, polar), shade types (pixel, circle, cloud, animated cloud), see [`settings.smd`](./gaia-universe-model/smd/settings.smd).

![](saved/mass_feh_age_polar-2.png)

![](docs/media/mass_feh_age_polar-2.png)

---

## Clone and build (CMake)

To generate the CMake targets, open the terminal and run the following commands:

```bash
git clone --recursive https://github.com/MrSinho/gaia-universe-model.git
cd gaia-universe-model
cd external/shengine
python export-application.py name=gaia-universe-model target=EXECUTABLE path=../../gaia-universe-model
```

if you get a python syntax error specify the python version (must be 3.0 or greater).

![](saved/mass_feh_age_polar__agecf.png)


On Windows:
```bash
cd gaia-universe-model/windows/build
cmake --build .
```
The windows binaries are compiled at gaia-universe-model/windows/bin

On Linux:
```bash
cd gaia-universe-model/linux/build
cmake --build .
```
## Feedback and contributing

The linux binaries are compiled at gaia-universe-model/linux/bin
I have been personally dedicated to this project since the beginning of 2022, investing a significant amount of my spare time. Should you encounter any issues with the application or wish to introduce new features while addressing existing ones, I welcome your contributions to the repository. You can contribute by either opening an issue or submitting a pull request.

![](saved/age_mass_feh__fehcf_cartesian.png)
---
Empty file.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/media/download-release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/gaia-universe-model-startup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/media/shinstaller-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/shinstaller.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions docs/quick-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Install latest release using [shinstaller](https://github.com/MrSinho/gaia-universe-model/releases/latest)

---

## 1. Run shinstaller

Just download, and extract the [`shinstaller`](https://github.com/MrSinho/gaia-universe-model/releases/latest) zip file included in the [_Gaia Universe Model latest release_](https://github.com/MrSinho/gaia-universe-model/releases/latest). After running the executable (or the python script for linux users), an interface similar to this one will appear on your Desktop (the version name might be different):

![](/docs/media/shinstaller.png)

If you need to change the `installation directory`, you can change it before installing. Press install:

![](/docs/media/shinstaller-install.png)

---

## 2. Install Gaia Data Release binaries

> Note: the following step needs a python3.11+ interpreter to be already installed in your system.
Now navigate to the installation path and find the `scripts` directory (by default: `C:\Sinho Softworks\gaia-universe-model-x64-v1.0.0\gaia-universe-model-x64-v1.0.0\gaia-universe-model-win64-v1.0.0\scripts`).

If you're working on a windows system, run `download-release.bat`, and wait until the console application closes automatically:

![](/docs/media/download-release.png)

---

## 3. Run executable

Starting from the root directory of the program, go to `gaia-universe-model/windows_or_linux/bin` and run `gaia-universe-model.exe`. By default, on Windows, the executable path is located here: `C:\Sinho Softworks\gaia-universe-model-x64-v1.0.0\gaia-universe-model-x64-v1.0.0\gaia-universe-model-win64-v1.0.0\gaia-universe-model\windows\bin`.

![](/docs/media/gaia-universe-model-startup.png)

---

## 4. How to use gaia-universe-model application

See the guide at [docs/runtime-tutorial.md](/docs/runtime-tutorial.md)
Empty file removed docs/runtime-tutorial-md
Empty file.
File renamed without changes.
118 changes: 118 additions & 0 deletions docs/terminal-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Install gaia-universe-model using terminal

---

## 1. Clone and build (cmake)

To generate the CMake targets, open the terminal with admin/root permission and run the following commands:

```bash
git clone --recursive https://github.com/MrSinho/gaia-universe-model.git
cd gaia-universe-model
cd external/shengine
python export-application.py name=gaia-universe-model target=EXECUTABLE path=../../gaia-universe-model
```

if you get a python syntax error, try specifying the python version (must be 3.0 or greater).

![](/docs/media/mass_feh_age_polar__agecf.png)


On Windows:
```bash
cd scripts
start download-release.bat
cd ../
cd gaia-universe-model/windows/build
cmake --build .
```
The windows binaries are compiled at gaia-universe-model/windows/bin

On Linux:
```bash
cd scripts
start download-release.sh
cd ../
cd gaia-universe-model/linux/build
cmake --build .
```

The linux binaries are compiled at gaia-universe-model/linux/bin

---

## 2. Move ini file

The engine needs to know where to locate the universe model assets path, and some general properties of the application:

On Windows:

```bash
#starting from root repo
cd gaia-universe-model/
cp ini.smd windows/bin/ini.smd
```

On Linux:

```bash
#starting from root repo
cd gaia-universe-model/
cp ini.smd linux/bin/ini.smd
```

![](/docs/media/age_mass_feh__fehcf_cartesian.png)

---

## 3. Download Gaia Data Release binaries

> Note: the following step needs a python3.11+ interpreter to be already installed in your system.
Now navigate to the installation path and find the `scripts` directory and run the `download-release` batch/shell script:

On Windows:

```bash
#starting from root repo
cd scripts/
start download-release.bat
```

On Linux:

```bash
#starting from root repo
cd scripts/
sudo bash download-release.sh
```

---

## 4. Run executable

Starting from the root directory of the program, go to `gaia-universe-model/os/bin` and run the `gaia-universe-model` executable file.

```bash
#starting from root repo
cd gaia-universe-model/windows/bin
start gaia-universe-model.exe
```

On Linux:

```bash
#starting from root repo
cd gaia-universe-model/linux/bin
./gaia-universe-model
```

![](/docs/media/gaia-universe-model-startup.png)

---

## 5. How to use gaia-universe-model application

See the guide at [docs/runtime-tutorial.md](/docs/runtime-tutorial.md)

---
Binary file removed saved/editor.mp4
Binary file not shown.

0 comments on commit 9238f77

Please sign in to comment.