README.md 3.27 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
![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
handle them (conversions, propagations, pointing, ...).

13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
## Download

### Official releases

[Official Orekit releases](https://gitlab.orekit.org/orekit/orekit/releases)
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).

33
34
35
36
37
38
39
40
41
42
43
44
45
46
## Documentation

Project overview, architecture and development, detailed features list,
tutorials, Javadoc and a lot of other information is available on the
[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
[issues tracking system](https://gitlab.orekit.org/orekit/orekit/issues).

## Contributing

47
48
49
Orekit exists thanks to the contribution of
[many people](https://gitlab.orekit.org/orekit/orekit/graphs/develop).

50
51
52
53
If you are interested in participating in the development effort, subscribe to
the [forum](https://forum.orekit.org/) and step up to discuss it. The larger
the community is, the better Orekit will be. The main rule is that everything
intended to be included in Orekit core must be distributed under the Apache
54
License, version 2.0 (you will be asked to sign a contributor license
55
56
57
58
59
60
61
62
63
64
65
66
agreement).

More information is available in our
[development guidelines](https://www.orekit.org/site-orekit-development/guidelines.html).

## 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

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

Sebastien Dinot's avatar
Sebastien Dinot committed
71
### Compile-time/run-time dependencies
72

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

Sebastien Dinot's avatar
Sebastien Dinot committed
76
### Test-time dependencies
77

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

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

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

## License

Orekit is licensed by [CS Systèmes d'Information](https://www.c-s.fr/) under
90
the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
91
A copy of this license is provided in the [LICENSE.txt](LICENSE.txt) file.