How to Install from GitHub

Intro

In the dreadful case a program cannot run, or in the hopeful case of wanting to use the most recent version of the code, you can follow the next steps. It might be a little difficult for the untrained, but I promise, it is worth your time.

Install Python

First, download python 3.8 and then install it. For help in installing python, you can follow this guide.

Install Caelian Assistant Python Package

Once python is installed, you can visit the GitHub repository of the Caelian Assistant of your choice. To download the code, click on the green "Code" button, and then click download zip (or click on the direct download link bellow).

• Stellar System Creator repository (direct download)

• Spherize Textures repository (direct download)

• Transparent Star repository (direct download)

To install the new package you downloaded (e.g. package-master.zip) you need to go to your computer's command line (or terminal).

• For windows: Go to the menu, search "cmd" and select the terminal looking item that pops up.

• For Mac and Linux: Search "terminal" and select the item that pops up. (helpful link).

Then you need to run these lines:

pip install ./package-master.zip

pip install numpy==1.21.5

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" (only for macOS)

brew install cairo (only for macOS)

pip install pycairo (only for windows)

or if this doesn't work, try:

pip3 install ./package-master.zip

pip3 install numpy==1.21.5

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" (only for macOS)

brew install cairo (only for macOS)

pip3 install pycairo (only for Windows)

Open Caelian Assistant with Python

To open the Graphics User Interface (GUI), you need to download the corresponding python files:

• Stellar System Creator

• Spherize Textures

• Transparent Star

You may unzip the file at a folder (e.g. 'folder 1/folder 2/folder 3') of your choice. Once you unzip it you will find three files there, a logo.ico, pyinstaller_script.py, and Caelian_Assistants_XX_XX.py. The latter is the python file that opens the GUI of the Caelian Assistant of your choice. Now you need to open the terminal as instructed above, and move the terminal working folder (directory) to the one your file is in. you can do that by writing the command:

cd 'folder 1/folder 2/folder 3'

Each platform has their own command line intricacies but there are many tutorials online on how to use them. Hopefully you won't have trouble with the "cd" command.

The final step is here! In the command line, write

python Caelian_Assistants_XX_XX.py or if it doesn't work, try python3 Caelian_Assistants_XX_XX.py

This command should open a new window, which would be the program you wanted to run. Congratulation on running your first python script, and thank you for your patience!

Extra: Make your own executable/application file

If you wish to go one step further and not have to open the command line every time you want to run the program, follow these steps:

• As before, open the terminal, and "cd" to the folder where the unzipped file pyinstaller_script.py is.

• Install the python module pyinstaller with the command pip install pyinstaller

• Run the command python pyinstaller_script.py

• For MacOS, there might be an error "SystemError: lipo failure!" If so, a prompt will pop up, asking to install lipo. Doing so will allow us to make the *.app file. It takes about 30 minutes. Once lipo is installed, rerun the previous python command.

• Allow your computer some time to run this line. What is does is that it creates two folders a build and a dist folder.

• Once it is completed, go to the dist folder, and you will find a folder with name Caelian_Assistants_XX_XX_v0.#.#.#.

• Finally, go in this sub-folder Caelian_Assistants_XX_XX_v0.#.#.#. and open the file with the same name as the sub-folder.

Note: it would be better if you made a virtual python environment (venv) in the unzipped file folder, installed package.zip in the venv, and then proceed with running the python pyinstaller_script.py command. This method might make your executable folders lighter if you have used python for other reasons, but is not necessary.

Questions and Issues

If you are having trouble, feel free to shoot me an email at selewirre@gmail.com or contact me via the contact form. I will be more than happy to assist you.