Skip to content
This repository has been archived by the owner on Jul 15, 2024. It is now read-only.

Latest commit

 

History

History
57 lines (36 loc) · 2.47 KB

README.md

File metadata and controls

57 lines (36 loc) · 2.47 KB
Raw

orekit-pip

This was an attempt at providing the Orekit Python Wrapper on PyPi.

IMPORTANT NOTE: THIS REPOSITORY IS ARCHIVED, OREKIT PYTHON IS NOW AVAILABLE ON PYPI THANKS TO THE NEW JPYPE WRAPPER: https://pypi.org/project/orekit-jpype/

Requirements

  • A C++ compiler
    • For Windows, see below
    • For Linux, this is gcc and g++
  • pip

Windows

  • Install the Visual C++ build tools, version 14.0 or greater: https://visualstudio.microsoft.com/visual-cpp-build-tools/
  • Additionally, install the two following modules as shown in the screenshot below:
    • Windows 11 SDK (or Windows 10 SDK if you're using Windows 10)
    • Windows Universal CRT SDK

Installation

This can take a couple of minutes because it single-threadingly compiles the Orekit C++ bindings.

  • pip install git+https://github.com/GorgiAstro/orekit-pip.git

Local installation:

  • git clone this repo
  • pip install ..

Testing

python test/orekit-hello-world.py

Code generation

This doesn't need to be done by the normal user, it is mostly done by the package publishers when a new version of Orekit is available for example.

This does the following:

  • Copies the Orekit JARs and some Python additions (from https://github.com/petrushy/orekit_python_artifacts) to the build/orekit folder
  • Calls jcc to generate Orekit's C++ bindings in the build/_orekit folder
    • jcc also generates the setup.py script which configures the compilation of the Orekit C++ extension. This script will then be called by setuptools (together with the definitions in pyproject.toml) when running pip install

To do that:

  • pip install -r requirements-generate.txt
  • python generate.py
  • Clean up the generated setup.py file with a git diff tool (this is still a manual step):
    • If the package_data and sources lines changed, accept these changes
    • Otherwise, discard all the other changes to this file: the include paths and the link and compile arguments are managed by jcc

Limitations