diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..0e3c6e84f131f20e527d60959363a2f2f67f1525 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Description + +Orekit (ORbit Extrapolation KIT) is a free java library providing basic space dynamics objects and services. + +This repository contains examples and some additional scripts. + +# Licensing + +Orekit is licensed under the Apache License Version 2.0. +A copy of this license is provided in the LICENSE.txt file. + +# Content + +The python-wrapper project allows using orekit in a python environment. This repository contains some key files if building the wrapper from scratch. For many applications it is recommended to use pre-built conda packages through the conda-forge python system. See the [wiki](https://gitlab.orekit.org/orekit-labs/python-wrapper/-/wikis/home) for more details. + +# Building from source + +The sources for the java classes that allows Python subclassing are no longer in a separate package but integrated in a modified orekit source fork. + +This fork is available at https://github.com/petrushy/Orekit + +A compiled jar and some other artifacts are available at https://github.com/petrushy/orekit_python_artifacts + +Build scripts for the automated conda package builds are at https://github.com/conda-forge/orekit-feedstock/tree/main/recipe + +# Support + +For additional support please see the [orekit forum](https://forum.orekit.org/latest) diff --git a/README.txt b/README.txt deleted file mode 100644 index 9119b18d75a772dca4212efd8f61702d57b50d67..0000000000000000000000000000000000000000 --- a/README.txt +++ /dev/null @@ -1,32 +0,0 @@ -Orekit (ORbit Extrapolation KIT) is a free java library -providing basic space dynamics objects and services. - -This repository contains examples and some additional scripts. - -Orekit is licensed under the Apache License Version 2.0. -A copy of this license is provided in the LICENSE.txt file. - -The python-wrapper project allows using orekit in a -python environment. This repository contains some key files -if building the wrapper from scratch. For many applications -it is recommended to use pre-built conda packages through -the conda-forge python system. See the wiki for more details, - -https://gitlab.orekit.org/orekit-labs/python-wrapper/-/wikis/home - - -The sources for the java classes that allows Python subclassing are no longer in a separate package -but integrated in a modified orekit source fork. - -This fork is available at: -https://github.com/petrushy/Orekit - -A compiled jar and some other artifacts are available at: -https://github.com/petrushy/orekit_python_artifacts - -build scripts for the automated conda package builds are at: -https://github.com/conda-forge/orekit-feedstock/tree/main/recipe - -For additional support please see the orekit forum: -https://forum.orekit.org/latest -