Test Atom Project is for testing and playing around with ATOM.

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
• Doxygen (optional)
• Gcov (optional)
• LCOV (optional)

`In addition, Test Atom Project depends on the following libraries:

• SML (math library)
• PyKEP (ESA scientific library for interplanetary trajectory design)
• Astro (astrodynamics library)
• GSL (GNU scientific library that includes non-linear root-finders used)
• SGP4 (SGP4/SDP4 library)
• CATCH (unit testing library necessary for BUILD_TESTS option)
• Eigen (linear algebra library necessary for BUILD_TESTS_WITH_EIGEN option)

These dependencies will be downloaded and configured automatically (except PyKEP) if not already present locally (requires an internet connection). It takes a while to install GSL automagically, so it is recommended to pre-install if possible using e.g., Homebrew on Mac OS X, apt-get on Ubuntu, Gsl for Windows)..

Before running any commands, go to subdirectory /src and open the C++ file 'TleGen.cpp' for editing. Change the "include" location for the header file par2ic.h (Assuming that you have already installed the PyKEP library from ESA) to wherever you have that header file located on your system. Once done, follow the procedure given below.

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

git clone https://github.com/abhi-agrawal/TestAtomProject.git
cd TestAtomProject
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.

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

• -DPROJECT_SUMMARY: set short string summary for your project
• -DPROJECT_VENDOR_NAME: set short string name for vendor of your project
• -DPROJECT_VENDOR_CONTACT: set short string email address for vendor of your project
• -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.

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, including FindCppProject.cmake template for project-specific module.
• 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/CppProject: Project header files (*.hpp)
• scripts: Shell scripts used in Travis CI build
• src: Project source files (*.cpp), including main.cpp
• test: Project test source files (*.cpp), including testCppProject.cpp, which contains include for Catch
• .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

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