Welcome to SISPO’s documentation!¶
Space Imaging Simulator for Proximity Operations (SISPO)¶
Currently, a problem exists with the mathutils
import in the sim.py
. An import of bpy
must be done before running sispo.
Documentation¶
Currently, the most extensive documentation on the project can be found in the doc
folder. It contains the master thesis that was the starting point of this repository. The thesis is written in Latex and might need to be compiled.
Another kind of documentation is started using Read the Docs. It can be found by following the badge.
If you are using this package in a code project, please acknowledge by adding our badge to your readme file by copying:
[![sispo](https://img.shields.io/badge/powered%20by-sispo-orange?style=flat)](https://github.com/YgabrielsY/sispo)
There is another repository linked to sispo which uses Docker to simplify the installation. Can be found here sispo_docker
Overall python software structure¶
Figure 1: Overall software structure with main package, sub-packages, modules and sub-modules.
A more detailed definition of classes, methods and attributes can be found under sispo
and its sub-packages.
SISPO execution flow diagram¶
Figure 2: Software flow diagram showing how functions are executed step by step.
Figure 3: Software flow diagram showing how functions are executed step by step during simulation.
Figure 4: Software flow diagram showing how functions are executed step by step during reconstruction.