Skip to content

Latest commit

 

History

History
67 lines (37 loc) · 2.5 KB

README.md

File metadata and controls

67 lines (37 loc) · 2.5 KB

Tudat Bundle

The Tudat bundle contains Tudat and a number of external libraries in a modular fashion. The TU Delft Astrodynamics Toolbox (Tudat) is a set of C++ software libraries for simulating various astrodynamics applications, for more info see the Tudat website.

Instructions

This document contains minimal information on how to build the Tudat bundle. For more information see documentation below.

Building the project

  1. Clone the repository on your computer (or fork and then clone)

     git clone https://github.com/tudat/tudatBundle.git
    
  2. Enter the new directory

     cd tudatBundle
    
  3. Checkout all the submodules (optionally you can clone only the necessary submodules)

     git submodule update --init --recursive
    
  4. Make a new build directory and enter

     mkdir build && cd build
    
  5. Initiate CMake for the project

     cmake ../
    
  6. Build the project

     make
    

Note: it can happen that due to dependencies between the submodules the make process quits with an error (after building SPICE or JSONCPP, for instance). In this case, please repeat steps 5 and 6 once or twice.

### Switching on/off libraries and applications

By default only the SPICE library is build. You can enable/disable which libraries are build by manipulating special use switches:

  1. Each library has such a switch, these are: USE_CSPICE, USE_JSONCPP, USE_NRLMSISE and USE_PAGMO.

  2. You can turn on or off such a switch as an argument to CMake. For instance, the following will disable SPICE, but enable the nrlmsise-00 atmopshere model:

     cmake ../ -DUSE_CSPICE=0 -DUSE_NRLMSISE=1
    

Detailed control and to specification of detailed build options for external libraries (like building of examples and tests) can be achieved by editing CMakeLists.txt.

Creating your own applications

  1. Copy the templateApplication from tudatExampleApplications to tudatApplications and give it your own name:

     cp -R tudatExampleApplications/templateApplication tudatApplications/myApplication
     cd tudatApplications/myApplication
     mv TemplateApplication MyApplication
    
  2. Add your project to the top-level CMakeLists.txt, like so:

     add_subdirectory("${PROJECTROOT}/tudatApplications/myApplication/MyApplication")
    
  3. Re-run cmake and make commands.

Documentation