Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 6.04 KB

README.md

File metadata and controls

108 lines (76 loc) · 6.04 KB
Raw

rvdsim

rvdsim is a spacecraft rendezvous simulator.

Features

Requirements

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

In addition, rvdsim depends on the following libraries:

  • SML (math library)
  • Astro (astrodynamics library)
  • Control (control algorithms library)
  • RapidJSON (JSON library)
  • CATCH (unit testing library necessary for BUILD_TESTS option)

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

Installation

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

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

To install the header files, libraries and executables, 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.

To install the necessary Python libraries for the plotting scripts, run the following command.

pip install -r python/requirements.txt

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 .. command, e.g., to build the tests:

cmake -DBUILD_TESTS=on ..

N.B.: Toggling options to build tests using ccmake does not work correctly, as the necessarily libraries are not download automagically!

Project structure

This project has been set up with a specific file/folder structure in mind. The following describes some important features of this setup:

  • cmake/Modules : Contains CMake modules
  • docs: Contains project-specific docs in Markdown that are also parsed by Doxygen. This sub-directory includes global_todo.md, which contains a global list of TODO items for project that appear on TODO list generated in Doxygen documentation
  • doxydocs: HTML output generated by building Doxygen documentation
  • include/rvdsim: Project header files (*.hpp)
  • scripts: Shell scripts used in Travis CI build
  • src: Project source files (*.cpp), including main.cpp, which contains example main-function for project build
  • test: Project test source files (*.cpp) to generate unit tests using the Catch framework
  • .travis.yml: Configuration file for Travis CI build, including static analysis using Coverity Scan and code coverage using Coveralls
  • CMakeLists.txt: main CMakelists.txt file for project (should not need to be modified for basic build)
  • Dependencies.cmake: list of dependencies and automated build, triggered if dependency cannot be found locally
  • Doxyfile.in: Doxygen configuration file, adapted for generic use within project build (should not need to be modified)
  • LICENSE.md: license file for project (copyright statement needs to be edited)
  • ProjectFiles.cmake: list of project source files to build
  • README.md: project readme file, parsed as main page for Doxygen documentation

Contributing

Once you've made your great commits:

  1. Fork rvdsim
  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 rvdsim.