README.md 2.95 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
## 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
43 44
[issues tracking system](https://gitlab.orekit.org/orekit/orekit/issues). When
reporting security issues check the "This issue is confidential" box.
45 46 47

## Contributing

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

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

61 62 63
Orekit relies on the following
[FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) libraries,
all released under business friendly FOSS licenses.
64

65
### Compile-time/run-time dependencies
66

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

70
### Test-time dependencies
71

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

75
* [Mockito](https://site.mockito.org/), a mocking framework for unit tests,
76 77 78
  released under MIT license.

More detailed information is available in the
79
[Maven site](https://www.orekit.org/site-orekit-development/dependencies.html).
80 81 82 83

## License

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