Getting Started
System Prerequisites
SSAPy
has the following minimum system requirements, which are assumed to be present on the machine where SSAPy
is run:
Name |
Supported Versions |
Notes |
Requirement Reason |
---|---|---|---|
Python |
3.8–3.11 |
Interpreter |
|
C/C++ Compilers |
Building software |
||
make |
Build software |
||
git |
Manage software repositories |
||
git-lfs |
Track large binary files |
||
graphviz |
Local documentation building |
These requirements can be easily installed on most modern macOS and Linux systems.
apt update
apt install build-essential git git-lfs python3 python3-distutils python3-venv graphviz
dnf install epel-release
dnf group install "Development Tools"
dnf install git git-lfs gcc-gfortran python3 python3-pip python3-setuptools graphviz
brew update
brew install gcc git git-lfs python3 graphviz
Installation
As the package has not yet been published on PyPI, it CANNOT be installed using pip. Instead, use the following directions to install the package.
After cloning the main git repository, you must run the following command to clone the submodules:
git submodule update --init --recursive
Then checkout the large files
git lfs install
git lfs pull
Then run the usual setup commands:
python3 setup.py build
python3 setup.py install
Orekit dependency
Orekit is an optional dependency, including the Orekit
Python wrapper that is hard to find. Clone the python wrappper from here:
Alternatively, the Orekit
python wrapper can be installed from Anaconda.