TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-12-22 20:35:44 +01:00
Code Issues Projects Releases Wiki Activity

Add python-install description to README

Browse Source
This commit is contained in:
q-posev 2022-04-29 12:52:05 +02:00
parent 9bbfc34ee5
commit e37e950d85
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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