README.md 3.37 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
![Orekit logo](https://www.orekit.org/img/orekit-logo.png)

# Orekit

> An accurate and efficient core layer for space flight dynamics applications

[Orekit](https://www.orekit.org) is a low level space dynamics library written
in Java. Orekit is designed to be easily used in very different contexts, from
quick studies up to critical operations. As a library, Orekit provides basic
elements (orbits, dates, attitude, frames, ...) and various algorithms to
11
handle them (conversions, propagations, pointing, events detection, orbit determination ...).
12

13
[![](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
14
15
[![](https://sonar.orekit.org/api/project_badges/measure?project=orekit%3Aorekit&metric=alert_status)](https://sonar.orekit.org/dashboard?id=org.orekit%3Aorekit)
[![](https://sonar.orekit.org/api/project_badges/measure?project=orekit%3Aorekit&metric=coverage)](https://sonar.orekit.org/dashboard?id=org.orekit%3Aorekit)
Guilhem Bonnefille's avatar
Guilhem Bonnefille committed
16

17
18
19
20
## Download

### Official releases

21
[Official Orekit releases](https://gitlab.orekit.org/orekit/orekit/-/releases)
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
are available on our [Gitlab instance](https://gitlab.orekit.org/). They are
also available in the
[Maven repository](https://mvnrepository.com/artifact/org.orekit/orekit).

### Development version

To get the latest development version, please clone our official repository
and checkout the `develop` branch:

```bash
git clone -b develop https://gitlab.orekit.org/orekit/orekit.git
```
__Note:__ Our official repository is
[mirrored on Github](https://github.com/CS-SI/Orekit).

37
38
39
## Documentation

Project overview, architecture and development, detailed features list,
40
Javadoc and a lot of other information is available on the
41
42
43
44
45
46
[Maven site](https://www.orekit.org/site-orekit-development/).

## Getting help

The main communication channel is our [forum](https://forum.orekit.org/). You
can report bugs and suggest new features in our
47
48
[issues tracking system](https://gitlab.orekit.org/orekit/orekit/issues). When
reporting security issues check the "This issue is confidential" box.
49
50
51

## Contributing

52
53
Orekit exists thanks to the contribution of
[many people](https://gitlab.orekit.org/orekit/orekit/graphs/develop).
54
55
56
Please take a look at our
[contributing guidelines](src/site/markdown/contributing.md) if you're
interested in helping!
57
58
59
60
61
62
63
64

## Building

Detailed information on how to build Orekit from source either using Maven or
Eclipse is provided in [building.md](src/site/markdown/building.md) file.

## Dependencies

65
66
67
Orekit relies on the following
[FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) libraries,
all released under business friendly FOSS licenses.
68

Sebastien Dinot's avatar
Sebastien Dinot committed
69
### Compile-time/run-time dependencies
70

71
* [Hipparchus](https://hipparchus.org/), a mathematics library released under
Sébastien Dinot's avatar
Sébastien Dinot committed
72
  the Apache License, version 2.0.
73

Sebastien Dinot's avatar
Sebastien Dinot committed
74
### Test-time dependencies
75

76
* [JUnit 4](http://www.junit.org/), a widely used unit test framework released
Sébastien Dinot's avatar
Sébastien Dinot committed
77
  under the Eclipse Public License, version 1.0.
78

79
* [Mockito](https://site.mockito.org/), a mocking framework for unit tests,
80
81
82
  released under MIT license.

More detailed information is available in the
83
[Maven site](https://www.orekit.org/site-orekit-development/dependencies.html).
84
85
86

## License

87
Orekit is licensed by [CS GROUP](https://www.c-s.fr/) under
88
the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
89
A copy of this license is provided in the [LICENSE.txt](LICENSE.txt) file.