README.md



Orekit

An accurate and efficient core layer for space flight dynamics applications

Orekit 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, ...).

Documentation
Project overview, architecture and development, detailed features list,
tutorials, Javadoc and a lot of other information is available on the
Maven site.

Getting help
The main communication channel is our forum. You
can report bugs and suggest new features in our
issues tracking system.

Contributing
If you are interested in participating in the development effort, subscribe to
the forum 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
License Version 2.0 (you will be asked to sign a contributor license
agreement).
More information is available in our
development guidelines.

Building
Detailed information on how to build Orekit from source either using Maven or
Eclipse is provided in building.md file.
Official Orekit artifacts
are available on Maven public repository and on the
Orekit web site.

The src/main/java directory contains the library sources.
The src/main/resources directory contains the library
data.
The src/test/java directory contains the tests sources.
The src/test/resources directory contains the tests
data.
The src/tutorials/java directory contains sources for
example use of the library.
The src/tutorials/resources directory contains
example data.
The src/design directory contains pieces for a UML model of
the library.


Dependencies
Orekit relies on the following free software, all released under business
friendly free licenses.

Compile-time/run-time dependency


Hipparchus from the Hipparchus project released
under the Apache Software License, version 2


Test-time dependency


JUnit 4 from Erich Gamma and Kent Beck released
under the Eclipse Public License, version 1.0


Mockito from Szczepan Faber and others,
released under MIT license.


More detailed information is available in the
Maven site.

License
Orekit is licensed by CS Systèmes d'Information under
the Apache License Version 2.0.
A copy of this license is provided in the LICENSE.txt file.