From 9d431339fe2bd06ec5fb7b83ef67d7dbf7f50197 Mon Sep 17 00:00:00 2001 From: Kartik Kumar Date: Wed, 12 Dec 2018 17:47:50 +0100 Subject: [PATCH] Update Doxygen install script for Travis CI, update Doxygen config file to 1.8.14, make minor changes to main readme, and update Doxygen output stored in /docs. --- .gitignore | 3 + .travis.yml | 2 +- Doxyfile.in | 85 ++++++++++++------- README.md | 4 +- docs/README_8md.html | 2 +- docs/README_8md_source.html | 4 +- docs/astro_8hpp.html | 2 +- docs/astro_8hpp_source.html | 2 +- docs/centralBodyAccelerationModel_8hpp.html | 2 +- ...tralBodyAccelerationModel_8hpp_source.html | 2 +- docs/constants_8hpp.html | 2 +- docs/constants_8hpp_source.html | 2 +- .../dir_0fc3206047eab508bd310c9d22a11fd1.html | 2 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 2 +- docs/files.html | 2 +- docs/index.html | 4 +- docs/j2AccelerationModel_8hpp.html | 2 +- docs/j2AccelerationModel_8hpp_source.html | 2 +- docs/namespaceastro.html | 2 +- docs/namespacemembers.html | 2 +- docs/namespacemembers_enum.html | 2 +- docs/namespacemembers_eval.html | 2 +- docs/namespacemembers_func.html | 2 +- docs/namespacemembers_vars.html | 2 +- docs/namespaces.html | 2 +- docs/orbitalElementConversions_8hpp.html | 2 +- ...orbitalElementConversions_8hpp_source.html | 2 +- docs/pages.html | 2 +- ...diationPressureAccelerationModel_8hpp.html | 2 +- ...PressureAccelerationModel_8hpp_source.html | 2 +- docs/stateVectorIndices_8hpp.html | 2 +- docs/stateVectorIndices_8hpp_source.html | 2 +- docs/todo.html | 2 +- docs/twoBodyMethods_8hpp.html | 2 +- docs/twoBodyMethods_8hpp_source.html | 2 +- scripts/install_doxygen.sh | 11 ++- 36 files changed, 101 insertions(+), 70 deletions(-) diff --git a/.gitignore b/.gitignore index 1554b84..6f1f79c 100644 --- a/.gitignore +++ b/.gitignore @@ -38,3 +38,6 @@ external # Project files *.sublime* + +# System files +.DS_Store diff --git a/.travis.yml b/.travis.yml index cf8816a..8f41edd 100644 --- a/.travis.yml +++ b/.travis.yml @@ -55,7 +55,7 @@ script: - if [ "$COVERITY_SCAN_BRANCH_PATTERN" != "coverity_scan" ]; then mkdir build; cd build; - $HOME/cmake/bin/cmake -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DBUILD_TESTS=on -DDOXYGEN_EXECUTABLE=$HOME/doxygen/bin/doxygen -DBUILD_DOXYGEN_DOCS=on ..; + $HOME/cmake/bin/cmake -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DBUILD_TESTS=on -DDOXYGEN_EXECUTABLE=$HOME/doxygen/build/bin/doxygen -DBUILD_DOXYGEN_DOCS=on ..; make; ctest -V; ../scripts/check_doxygen.sh; diff --git a/Doxyfile.in b/Doxyfile.in index a73066c..8cbe803 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -1,4 +1,4 @@ -# Doxyfile 1.8.11 +# Doxyfile 1.8.14 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -20,8 +20,8 @@ # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. +# built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 @@ -226,7 +226,8 @@ TAB_SIZE = 4 # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. ALIASES = @@ -295,6 +296,15 @@ EXTENSION_MAPPING = i \ MARKDOWN_SUPPORT = YES +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or @@ -320,7 +330,7 @@ BUILTIN_STL_SUPPORT = YES CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. @@ -691,7 +701,7 @@ LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. @@ -780,7 +790,7 @@ INPUT = @INCLUDE_PATH@ \ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. @@ -797,8 +807,8 @@ INPUT_ENCODING = UTF-8 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, -# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. FILE_PATTERNS = *.hpp \ *.cpp \ @@ -990,7 +1000,7 @@ SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version +# (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: @@ -1135,7 +1145,7 @@ HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. @@ -1171,6 +1181,17 @@ HTML_COLORSTYLE_GAMMA = 80 HTML_TIMESTAMP = YES +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via Javascript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have Javascript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. @@ -1194,12 +1215,12 @@ HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# environment (see: https://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1315,7 +1336,7 @@ QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1323,8 +1344,7 @@ QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). +# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1332,23 +1352,21 @@ QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = @@ -1441,7 +1459,7 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # @@ -1453,7 +1471,7 @@ FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering +# https://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path @@ -1480,8 +1498,8 @@ MATHJAX_FORMAT = HTML-CSS # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest @@ -1542,7 +1560,7 @@ SERVER_BASED_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). +# Xapian (see: https://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. @@ -1555,7 +1573,7 @@ EXTERNAL_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). See the section "External Indexing and +# Xapian (see: https://xapian.org/). See the section "External Indexing and # Searching" for details. # This tag requires that the tag SEARCHENGINE is set to YES. @@ -1742,7 +1760,7 @@ LATEX_SOURCE_CODE = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. # The default value is: plain. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1925,9 +1943,9 @@ DOCBOOK_PROGRAMLISTING = NO #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an -# AutoGen Definitions (see http://autogen.sf.net) file that captures the -# structure of the code including all documentation. Note that this feature is -# still experimental and incomplete at the moment. +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# the structure of the code including all documentation. Note that this feature +# is still experimental and incomplete at the moment. # The default value is: NO. GENERATE_AUTOGEN_DEF = NO @@ -2349,6 +2367,11 @@ DIAFILE_DIRS = PLANTUML_JAR_PATH = +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + # When using plantuml, the specified paths are searched for files specified by # the !include statement in a plantuml block. diff --git a/README.md b/README.md index 7517b53..b204b77 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ astro === -\cond [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/kartikkumar/astro.svg?branch=master)](https://travis-ci.org/kartikkumar/astro) [![Coverity Scan Build Status](https://scan.coverity.com/projects/3697/badge.svg)](https://scan.coverity.com/projects/3697) [![Coverage Status](https://coveralls.io/repos/github/kartikkumar/astro/badge.svg?branch=master)](https://coveralls.io/github/kartikkumar/astro?branch=master) \endcond +\cond [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/kartikkumar/astro.svg?branch=master)](https://travis-ci.org/kartikkumar/astro) [![Coverity Scan Build Status](https://scan.coverity.com/projects/kartikkumar-astro/badge.svg)](https://scan.coverity.com/projects/kartikkumar-astro) [![Coverage Status](https://coveralls.io/repos/github/kartikkumar/astro/badge.svg?branch=master)](https://coveralls.io/github/kartikkumar/astro?branch=master) \endcond -astro is a C++ (template) library that provides basic astrodynamics functionality. It is intended to be lightweight and simple to use in other projects. A CMake module is available to make it easy to include astro in other CMake-based projects: [Findastro.cmake](https://github.com/openastro/cmake-modules/blob/master/Modules/Findastro.cmake). +astro is a header-only, C++ (template) library that provides basic astrodynamics functionality. It is intended to be lightweight and simple to use in other projects. A CMake module is available to make it easy to include astro in other CMake-based projects: [Findastro.cmake](https://github.com/openastro/cmake-modules/blob/master/Modules/Findastro.cmake). Features ------ diff --git a/docs/README_8md.html b/docs/README_8md.html index 00f0c36..e5a5462 100644 --- a/docs/README_8md.html +++ b/docs/README_8md.html @@ -99,7 +99,7 @@
-Go to the documentation of this file.
1 astro
2 ===
3 
4 \cond [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/kartikkumar/astro.svg?branch=master)](https://travis-ci.org/kartikkumar/astro) [![Coverity Scan Build Status](https://scan.coverity.com/projects/3697/badge.svg)](https://scan.coverity.com/projects/3697) [![Coverage Status](https://coveralls.io/repos/github/kartikkumar/astro/badge.svg?branch=master)](https://coveralls.io/github/kartikkumar/astro?branch=master) \endcond
5 
6 astro is a C++ (template) library that provides basic astrodynamics functionality. It is intended to be lightweight and simple to use in other projects. A CMake module is available to make it easy to include astro in other CMake-based projects: [Findastro.cmake](https://github.com/openastro/cmake-modules/blob/master/Modules/Findastro.cmake).
7 
8 Features
9 ------
10 
11  - Header-only, zero-dependency
12  - Orbital element conversions
13  - Methods related to the 2-Body Problem
14  - Useful physical constants
15  - Full suite of tests
16 
17 Requirements
18 ------
19 
20 To install this project, please ensure that you have installed the following (install guides are provided on the respective websites):
21 
22  - [Git](http://git-scm.com)
23  - A C++ compiler, e.g., [GCC](https://gcc.gnu.org/), [clang](http://clang.llvm.org/), [MinGW](http://www.mingw.org/)
24  - [CMake](http://www.cmake.org)
25  - [Doxygen](http://www.doxygen.org "Doxygen homepage") (optional)
26  - [Gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) (optional)
27  - [LCOV](http://ltp.sourceforge.net/coverage/lcov.php) (optional)
28 
29 The following dependencies are optional (see `Build options`):
30 
31  - [Catch2](https://github.com/catchorg/Catch2) (unit testing library necessary for `BUILD_TESTS` build option)
32 
33 These dependencies will be downloaded and configured automagically if not already present locally (requires an internet connection).
34 
35 Installation
36 ------
37 
38 Run the following commands to download, build, and install this project.
39 
40  git clone https://www.github.com/openastro/astro
41  cd astro
42  git submodule init && git submodule update
43  mkdir build && cd build
44  cmake .. && cmake --build .
45 
46 To install the header files, run the following from within the `build` directory:
47 
48  make install
49 
50 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.
51 
52 Build options
53 -------------
54 
55 You can pass the following, general command-line options when running CMake:
56 
57  - `-DCMAKE_INSTALL_PREFIX[=$install_dir]`: set path prefix for install script (`make install`); if not set, defaults to usual locations
58  - `-DBUILD_DOXYGEN_DOCS[=ON|OFF (default)]`: build the [Doxygen](http://www.doxygen.org "Doxygen homepage") documentation ([LaTeX](http://www.latex-project.org/) must be installed with `amsmath` package)
59  - `-DBUILD_TESTS[=ON|OFF (default)]`: build tests (execute tests from build-directory using `ctest -V`)
60  - `-DBUILD_DEPENDENCIES[=ON|OFF (default)]`: force local build of dependencies, instead of first searching system-wide using `find_package()`
61 
62 The following commands are conditional and can only be set if `BUILD_TESTS = ON`:
63 
64  - `-DBUILD_COVERAGE_ANALYSIS[=ON|OFF (default)]`: build code coverage using [Gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) and [LCOV](http://ltp.sourceforge.net/coverage/lcov.php) (both must be installed; requires [GCC](https://gcc.gnu.org/) compiler; execute coverage analysis from build-directory using `make coverage`)
65 
66 Pass these options either directly to the `cmake ..` command, e.g., to build the tests:
67 
68  cmake -DBUILD_TESTS=on ..
69 
70 N.B.: Toggling options to build tests using `ccmake` does not work correctly, as the necessarily libraries are not download automagically!
71 
72 Project structure
73 -------------
74 
75 This project has been set up with a specific file/folder structure in mind. The following describes some important features of this setup:
76 
77  - `cmake/Modules`: Contains `CMake` modules, including `Findastro.cmake` module
78  - `docs`: Contains code documentation generated by [Doxygen](http://www.doxygen.org "Doxygen homepage")
79  - `include/astro`: Project header files (*.hpp)
80  - `scripts`: Shell scripts used in [Travis CI](https://travis-ci.org/ "Travis CI homepage") build
81  - `test`: Project test source files (*.cpp) that are provided to the [Catch2](https://github.com/catchorg/Catch2 "Catch2 Github repository") framework
82  - `.travis.yml`: Configuration file for [Travis CI](https://travis-ci.org/ "Travis CI homepage") build, including static analysis using [Coverity Scan](https://scan.coverity.com/ "Coverity Scan homepage") and code coverage using [Coveralls](https://coveralls.io "Coveralls.io homepage")
83  - `CMakeLists.txt`: main `CMakelists.txt` file for project (should not need to be modified for basic build)
84  - `Dependencies.cmake`: list of dependencies and automated build, triggered if dependency cannot be found locally
85  - `Doxyfile.in`: [Doxygen](http://www.doxygen.org "Doxygen homepage") configuration file, adapted for generic use within project build (should not need to be modified)
86  - `LICENSE.md`: license file for project
87  - `ProjectFiles.cmake`: list of project source files to build
88  - `README.md`: project readme file, parsed as main page for [Doxygen](http://www.doxygen.org "Doxygen homepage") documentation
89 
90 Contributing
91 ------------
92 
93 Once you've made your great commits:
94 
95 1. [Fork](https://github.com/openastro/astro/fork) astro
96 2. Create a topic branch - `git checkout -b my_branch`
97 3. Push to your branch - `git push origin my_branch`
98 4. Create a [Pull Request](http://help.github.com/pull-requests/) from your branch
99 5. That's it!
100 
101 Disclaimer
102 ------------
103 
104 The copyright holders are not liable for any damage(s) incurred due to improper use of astro.
105 
106 TODO
107 ------------
108 
109 @todo Find a way to provide an option to clean installation.
110 
111 @todo Find a way to remove \cond \endcond workaround to get Doxygen to not throw warnings in readme.
112 
113 @todo Find a way to have nested variables in `Doxygen` config file so that e.g., `@@CMAKE_PROJECT_NAME@_VERSION@` works.
114 
115 @todo Add version detection in `CMake` module so that find_package respects minimum version required.
+Go to the documentation of this file.
1 astro
2 ===
3 
4 \cond [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/kartikkumar/astro.svg?branch=master)](https://travis-ci.org/kartikkumar/astro) [![Coverity Scan Build Status](https://scan.coverity.com/projects/kartikkumar-astro/badge.svg)](https://scan.coverity.com/projects/kartikkumar-astro) [![Coverage Status](https://coveralls.io/repos/github/kartikkumar/astro/badge.svg?branch=master)](https://coveralls.io/github/kartikkumar/astro?branch=master) \endcond
5 
6 astro is a header-only, C++ (template) library that provides basic astrodynamics functionality. It is intended to be lightweight and simple to use in other projects. A CMake module is available to make it easy to include astro in other CMake-based projects: [Findastro.cmake](https://github.com/openastro/cmake-modules/blob/master/Modules/Findastro.cmake).
7 
8 Features
9 ------
10 
11  - Header-only, zero-dependency
12  - Orbital element conversions
13  - Methods related to the 2-Body Problem
14  - Useful physical constants
15  - Full suite of tests
16 
17 Requirements
18 ------
19 
20 To install this project, please ensure that you have installed the following (install guides are provided on the respective websites):
21 
22  - [Git](http://git-scm.com)
23  - A C++ compiler, e.g., [GCC](https://gcc.gnu.org/), [clang](http://clang.llvm.org/), [MinGW](http://www.mingw.org/)
24  - [CMake](http://www.cmake.org)
25  - [Doxygen](http://www.doxygen.org "Doxygen homepage") (optional)
26  - [Gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) (optional)
27  - [LCOV](http://ltp.sourceforge.net/coverage/lcov.php) (optional)
28 
29 The following dependencies are optional (see `Build options`):
30 
31  - [Catch2](https://github.com/catchorg/Catch2) (unit testing library necessary for `BUILD_TESTS` build option)
32 
33 These dependencies will be downloaded and configured automagically if not already present locally (requires an internet connection).
34 
35 Installation
36 ------
37 
38 Run the following commands to download, build, and install this project.
39 
40  git clone https://www.github.com/openastro/astro
41  cd astro
42  git submodule init && git submodule update
43  mkdir build && cd build
44  cmake .. && cmake --build .
45 
46 To install the header files, run the following from within the `build` directory:
47 
48  make install
49 
50 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.
51 
52 Build options
53 -------------
54 
55 You can pass the following, general command-line options when running CMake:
56 
57  - `-DCMAKE_INSTALL_PREFIX[=$install_dir]`: set path prefix for install script (`make install`); if not set, defaults to usual locations
58  - `-DBUILD_DOXYGEN_DOCS[=ON|OFF (default)]`: build the [Doxygen](http://www.doxygen.org "Doxygen homepage") documentation ([LaTeX](http://www.latex-project.org/) must be installed with `amsmath` package)
59  - `-DBUILD_TESTS[=ON|OFF (default)]`: build tests (execute tests from build-directory using `ctest -V`)
60  - `-DBUILD_DEPENDENCIES[=ON|OFF (default)]`: force local build of dependencies, instead of first searching system-wide using `find_package()`
61 
62 The following commands are conditional and can only be set if `BUILD_TESTS = ON`:
63 
64  - `-DBUILD_COVERAGE_ANALYSIS[=ON|OFF (default)]`: build code coverage using [Gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) and [LCOV](http://ltp.sourceforge.net/coverage/lcov.php) (both must be installed; requires [GCC](https://gcc.gnu.org/) compiler; execute coverage analysis from build-directory using `make coverage`)
65 
66 Pass these options either directly to the `cmake ..` command, e.g., to build the tests:
67 
68  cmake -DBUILD_TESTS=on ..
69 
70 N.B.: Toggling options to build tests using `ccmake` does not work correctly, as the necessarily libraries are not download automagically!
71 
72 Project structure
73 -------------
74 
75 This project has been set up with a specific file/folder structure in mind. The following describes some important features of this setup:
76 
77  - `cmake/Modules`: Contains `CMake` modules, including `Findastro.cmake` module
78  - `docs`: Contains code documentation generated by [Doxygen](http://www.doxygen.org "Doxygen homepage")
79  - `include/astro`: Project header files (*.hpp)
80  - `scripts`: Shell scripts used in [Travis CI](https://travis-ci.org/ "Travis CI homepage") build
81  - `test`: Project test source files (*.cpp) that are provided to the [Catch2](https://github.com/catchorg/Catch2 "Catch2 Github repository") framework
82  - `.travis.yml`: Configuration file for [Travis CI](https://travis-ci.org/ "Travis CI homepage") build, including static analysis using [Coverity Scan](https://scan.coverity.com/ "Coverity Scan homepage") and code coverage using [Coveralls](https://coveralls.io "Coveralls.io homepage")
83  - `CMakeLists.txt`: main `CMakelists.txt` file for project (should not need to be modified for basic build)
84  - `Dependencies.cmake`: list of dependencies and automated build, triggered if dependency cannot be found locally
85  - `Doxyfile.in`: [Doxygen](http://www.doxygen.org "Doxygen homepage") configuration file, adapted for generic use within project build (should not need to be modified)
86  - `LICENSE.md`: license file for project
87  - `ProjectFiles.cmake`: list of project source files to build
88  - `README.md`: project readme file, parsed as main page for [Doxygen](http://www.doxygen.org "Doxygen homepage") documentation
89 
90 Contributing
91 ------------
92 
93 Once you've made your great commits:
94 
95 1. [Fork](https://github.com/openastro/astro/fork) astro
96 2. Create a topic branch - `git checkout -b my_branch`
97 3. Push to your branch - `git push origin my_branch`
98 4. Create a [Pull Request](http://help.github.com/pull-requests/) from your branch
99 5. That's it!
100 
101 Disclaimer
102 ------------
103 
104 The copyright holders are not liable for any damage(s) incurred due to improper use of astro.
105 
106 TODO
107 ------------
108 
109 @todo Find a way to provide an option to clean installation.
110 
111 @todo Find a way to remove \cond \endcond workaround to get Doxygen to not throw warnings in readme.
112 
113 @todo Find a way to have nested variables in `Doxygen` config file so that e.g., `@@CMAKE_PROJECT_NAME@_VERSION@` works.
114 
115 @todo Add version detection in `CMake` module so that find_package respects minimum version required.