Scarab

Scarab is a CMake-based C++ tool that can be used to simulate proximity operations in space.

Features

Requirements

To install this project, please ensure that you have installed the following (install guides are provided on the respective websites):

• Git
• A C++ compiler, e.g., GCC, clang, MinGW
• CMake
• Boost (collection of C++ libraries)
• Doxygen (optional)
• Gcov (optional)
• LCOV (optional)

The Boost libraries cannot be automatically downloaded and installed, as is possible for the libraries listed below. This choice has been made because compilation time can be very long. It is recommended that pre-build binaries are installed using e.g., Homebrew on Mac OS X or apt-get on Ubuntu.

In addition, Scarab is dependent upon the following libraries:

• CATCH (unit testing library necessary for BUILD_TESTS build option)
• Spot (library containing space proximity operation tools)

These dependencies will be downloaded and configured automagically if not already present locally (requires an internet connection).

Installation

Run the following commands to download, build, and install this project.

git clone https://www.github.com/kartikkumar/scarab
cd scarab
git submodule init && git submodule update
mkdir build && cd build
cmake .. && cmake --build .

To install the header files, run the following from within the build directory:

make install

Note that dependencies are installed by fetching them online, in case they cannot be detected on your local system. If the build process fails, check the error log given. Typically, building fails due to timeout. Simply run the cmake --build . command once more.

Build options

You can pass the following, general command-line options when running CMake:

• -DCMAKE_INSTALL_PREFIX[=$install_dir]: set path prefix for install script (make install); if not set, defaults to usual locations
• -DBUILD_SHARED_LIBS=[on|off (default)]: build shared libraries instead of static
• -DBUILD_MAIN[=on|off (default)]: build the main-function
• -DBUILD_DOXYGEN_DOCS[=ON|OFF (default)]: build the Doxygen documentation (LaTeX must be installed with amsmath package)
• -DBUILD_TESTS[=ON|OFF (default)]: build tests (execute tests from build-directory using ctest -V)
• -DBUILD_DEPENDENCIES[=ON|OFF (default)]: force local build of dependencies, instead of first searching system-wide using find_package()

The following command is conditional and can only be set if BUILD_TESTS = ON:

• -DBUILD_COVERAGE_ANALYSIS[=ON|OFF (default)]: build code coverage using Gcov and LCOV (both must be installed; requires GCC compiler; execute coverage analysis from build-directory using make coverage)

Pass these options either directly to the cmake .. build command or run ccmake .. instead to bring up the interface that can be used to toggle options.

Contributing

Once you've made your great commits:

1. Fork Scarab
2. Create a topic branch - git checkout -b my_branch
3. Push to your branch - git push origin my_branch
4. Create a Pull Request from your branch
5. That's it!

Disclaimer

The copyright holders are not liable for any damage(s) incurred due to improper use of Scarab.