HTTPS SSH

README {#README}

Basilisk

How do I get set up?

Of the following requirements Python is the only one for which prebuilt libraries are not included in the project repository:

  • Cmake for configuring the and generating the Visual Studio solution file or macOS XCode proejct.
  • Python 2.7 (numpy, matplotlib, pytest)

Setup a macOS Development Environment

Setup a Linux Development Environment

Setup a Windows Development Environment

Basilisk Development guidelines

Getting Started

To get started with Basilisk (BSK), several tutorial python files are provided in the installed package. Within this web page documentation site, they are listed and discussed in the <a href="modules.html">Modules</a> tab. The documentation lists the scenarios in an order that facilitates learning basic BSK features. In the source code they are stored under src\tests\scenarios. A good start would be to run scenarioBasicOrbit.py.

To play with the tutorials, it is suggested the user makes a copy of these tutorial files, and use the copies in order to learn, test and experiment. To copy them, first find the location of the Basilisk installation. After installing, you can find the installed location of Basilisk by opening a python interpreter and running:

import Basilisk
basiliskPath = Basilisk.__path__[0]
print basiliskPath

Now copy the folder {basiliskPath}/tests into a new folder, and change to that directory.

To run the default scenario 1 of scenarioBasicOrbit, in the directory of the copied tutorials, call the python script: python test_scenarioBasicOrbit.py

Now, when you want to use a tutorial, navigate inside that folder, and edit and execute the copied integrated tests.

<!--Any new BSK module development should not occur within the BSK folder as this will be updated rapidly. Rather, new FSW algorithm or simulation coce modules should be created in a custom folder outside of the BSK directory. A sample folder is provided named BasiliskCustom wich contains sample FSW and Simulation modules.-->

At this limited alpha release stage it is not recommended that custom BSK modules are written. We are working on the ability to develop custom BSK modules outside of the Basilisk folder. This will enable developers to safely write their own BSK modules and still be able to do a drop in replacement of future BSK releases.

To use the standalone 3D Visualization, download the Basilisk Qt code. This is more experimental, but does provide a 3D view of many of the simualtion states. The Viz and BSK simulation talk through TCP/IP. After opening the Viz, use the open connection or CMD-O command to open the default 127.0.0.1 address. In the test_scenarioXXX.py script, uncomment the marked 3 lines to enable a communication interface with the Viz.

Who do I talk to?