README.md
1libpredict
2==========
3
4A satellite orbit prediction library.
5
6
7Building
8--------
9
10We recommend using out-of-source builds.
11
12```
13cd $SOURCEDIR
14mkdir build
15cd build
16cmake ..
17make
18```
19
20
21Installation
22------------
23
24```
25make install
26```
27
28The install location is defined by `CMAKE_INSTALL_PREFIX`, which
29defaults to `/usr/local`. To relocate the whole installation (to make
30usr/local etc. inside another directory, e.g., if you want to make a
31tarball or package it afterwards), use `make DESTDIR=/foo/bar install`.
32
33Linking
34-------
35
36The library comes with pkg-config information, so the include and
37library paths and flags can be found using the `pkg-config` command or
38by using the `PKG_CHECK_MODULES` autotools macro or CMake command.
39
40Quickstart
41----------
42
43We recommend to investigate the examples under `examples/` and the API documentation in `include/predict/predict.h`.
44
45A condensed version is that
46```
47predict_orbital_elements_t *orbital_elements = orbital_elements = predict_parse_tle(tle_line_1, tle_line_2);
48```
49parses a TLE in the form of two char arrays to orbital elements representing a satellite, and that
50```
51predict_observer_t *observer = predict_create_observer(name, latitude_radians, longitude_radians, altitude_meters);
52```
53defines a QTH for observation. For prediction,
54```
55struct predict_position orbit;
56predict_orbit(orbital_elements, &orbit, prediction_time);
57```
58can be used to calculate properties that are independent of an observer (longitude, latitude, ...), while
59```
60struct predict_observation observation;
61predict_observe_orbit(observer, &orbit, &observation);
62```
63will convert to properties that will be relative to our observer (azimuth, elevation, ...).
64
65License
66-------
67
68 Copyright 1991-2006 John A. Magliacane (KD2BD)
69
70 Copyright 2013- Akademisk radioklubb (LA1K)
71
72 Copyright 2013-2015 Knut Magnus Kvamtrø (LA3DPA)
73
74 Copyright 2013-2015 Thomas Ingebretsen (LA9ERA)
75
76This program is free software; you can redistribute it and/or modify it
77under the terms of the GNU General Public License as published by the
78Free Software Foundation; either version 2 of the License, or (at your
79option) any later version.
80
81This program is distributed in the hope that it will be useful, but
82WITHOUT ANY WARRANTY; without even the implied warranty of
83MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
84Public License for more details.
85
86You should have received a copy of the GNU General Public License along
87with this program; if not, write to the Free Software Foundation, Inc.,
8851 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
89