Skip to content

Latest commit

 

History

History
117 lines (83 loc) · 5.04 KB

README_install.md

File metadata and controls

117 lines (83 loc) · 5.04 KB
Raw

Instalation

There are many options to run Exo-Striker. One may try an Anaconda environment, install it from pip, or run directly the source code from the repository.

All the methods listed below work in Linux, Windows, or MacOS if you have python and gfortran installed.

Getting the pip version

You can easily get the pip version by typing in the terminal:

pip install exostriker

or for e.g., python3.10

python3.10 -m pip install exostriker

Cloning from GitHub

Or you can directly clone from the GitHub page with:

git clone https://github.com/3fon3fonov/exostriker.git

After cloning, you can install it with pip or run it without any installation (see the Execution section).

To build the package and install it with pip from the source, type:

pip install build
cd exostriker
python3 -m build
pip install .

Adding the PATH (for non-Anaconda installations)

If you do not use Anaconda, you need to add the path of the pip scripts into the system path variable if you have not already done so.
This step is not necessary if you are running without installation.

Linux

For Linux users, you can add the following line in the end of the file ~/.bashrc, changing USER to your own user.

export PATH="${PATH}:/home/USER/.local/bin/"

The locale of the executables can slightly change for different Linux distributions and Python installations. If this does not work, you can try different paths, such as /usr/local/bin and others.

Windows

For Windows users, you need to open the menu and search for path, click in Edit the system environment variables, at the bottom right click in Environment Variables..., in the tab System variables (attention: not the User variables for Username), look for the variable Path and click on Edit. Add a new line with one of the following (check the Python location first):

C:\Users\Windows\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.11_qbz5n2kfra8p0\LocalCache\local-packages\Python311\Scripts

Or:

C:\Users\USERNAME\AppData\Local\Programs\Python\Python311\Scripts

Be aware of different Python versions, the path will change also. Always verify if the current path exists.

Step-by-Step for Windows

Obs: this step-by-step guide was made using a fresh new install of Windows 10.

Python: Go to Python Windows Releases and download a stable release by clicking on it and downloading the Windows installer (64-bit) Recommended. After downloading, execute the files and follow the installation process. - Add the Python folder to the path. - Open the menu and search for path, click in Edit the system environment variables, at the bottom right click in Environment Variables..., in the tab System variables (attention: not the User variables for Username), look for the variable Path and click on Edit. Add two new lines: - C:\Users\USERNAME\AppData\Local\Programs\Python\Python311 - C:\Users\USERNAME\AppData\Local\Programs\Python\Python311\Scripts - Change USERNAME with your username and Python311 to the actual version that you installed. - Go to the python folder (ex: C:\Users\USERNAME\AppData\Local\Programs\Python\Python311) and create a copy of the python.exe file in the same location with the name python3.11.exe

  • Gfortran: Download the x64 version of Winlibs.
    • Choose the x64 MCF with all the libraries;
    • After downloading, decompress the file and move the mingw64 folder to C:\Program Files\;
    • Now add the folder bin of the mingw64 folder to the path:
      • Use the same steps as before, but now add the line: C:\Program Files\mingw64\bin.
  • Microsoft Visual C++ for the package TTVFast: Download it and install the Microsft Build Tools, in the installation process, check the box for the Desktop development with C++ (6.52 GB) and then click to install.
  • Exostriker: In CMD type pip install exostriker or follow the above steps to install it.

Execution

With Installation

You can create menu entries for Exo-Striker by typing in the terminal or cmd:

exostriker-desktop-create

Then, search in the menu for Exostriker, and in Windows, a Desktop link will also be created.
However, if you do not want to create menu entries, you can launch it by typing exostriker or python—m exostriker in the terminal or cmd.

Without Installation

It is possible to execute the Exo-Striker without doing any installation! E.g.:

git clone https://github.com/3fon3fonov/exostriker.git
cd exostriker
python3 -m exostriker

Simply execute the file gui.py and it will power the GUI.

Uninstall

If you did not install with pip (both directly or by cloning), you could just erase the exostriker folder.

Otherwise, first, remove the menu entries (if you have added it) and then uninstall:

exostriker-desktop-remove
pip uninstall exostriker