-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
167 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 not shown.