From 259af6262748eb3fde0a94d3df8b65b57b4b64b6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Jonglez?= <clement@jonglez.space>
Date: Tue, 12 Mar 2024 12:27:52 +0100
Subject: [PATCH] add section in README.md explaining how to download this repo
 via pip

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index c3b28fe..27c6353 100644
--- a/README.md
+++ b/README.md
@@ -41,3 +41,15 @@ team uses to update the repository.
 
 There is *NO* guarantee that this convenience archive will be updated
 or even provided in the future.
+
+## Notes for Orekit Python users
+
+You can download this orekit data repository via pip (don't forget to activate your conda environment containing orekit beforehand):
+
+```bash
+pip install git+https://gitlab.orekit.org/orekit/orekit-data.git
+```
+
+This will install a Python library named `orekitdata`. The Python library receives a new version tag at every commit in this repository so that your Python project can pull the newest version of the orekit data every time this repository is updated. The 7 last characters of the version tag correspond to the 7 first characters of the git hash of the commit: for instance the Python version `orekitdata-0+untagged.70.g91b2c79` correspond to the commit of the `master` branch of this repository with a githash starting with `91b2c79`.
+
+Then to pass the data folder to Orekit in Python, follow the instructions in the [Python wrapper Wiki](https://gitlab.orekit.org/orekit-labs/python-wrapper/-/wikis/installation#physical-data).
-- 
GitLab