From e37e950d850af9189fd32fc4a934c81e6877efc1 Mon Sep 17 00:00:00 2001 From: q-posev Date: Fri, 29 Apr 2022 12:52:05 +0200 Subject: [PATCH] Add python-install description to README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 7a3a26c..1429f8a 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,18 @@ These quantities can be accessed using the corresponding `trexio_[has|read|write For more details regarding the installation and usage of the TREXIO Python API, see [this page](python/README.md). +The aforementioned instructions are adapted for users installing from the source code distribution (periodically updated). +In order to install the Python API with the latest changes, follow the developer installation guide and run the following command in the end + +``` +make python-install +``` + +**Note: this implies that both HDF5 and SWIG are installed and available. +At the moment, it is not possible to configure the Python API without HDF5 library.** + +We highly recommend to use virtual environments to avoid compatibility issues and to improve reproducibility. + ## Tutorial