yade.libVersions module

The yade.libVersions module tracks versions of all libraries it was compiled with. Example usage is as follows:

from yade.libVersions import *
if(getVersion('cgal') > (4,9,0)):
        …
else:
        …

To obtain a list of all libraries use the function libVersions.printAllVersions.

All libraries listed in prerequisites are detected by this module.

Note

If we need a version of some library not listed in prerequisites, then it must also be added to that list.

When adding a new version please have a look at these three files:

1. py/_libVersions.cpp: detection of versions from #include files by C++.

2. py/libVersions.py.in: python module which is constructed by cmake during compilation. All *.in files are processed by cmake.

3. cMake/FindMissingVersions.cmake: forced detection of library with undetectable version.

Hint

The safest way to compare versions is to use builtin python tuple comparison e.g. if(cgalVer > (4,9,0) and cgalVer < (5,1,1)):.

yade.libVersions.getAllVersions(rstFormat=False)

Returns:

str - this function returns the result of printAllVersions(rstFormat) call inside a string variable.

yade.libVersions.getAllVersionsCmake()

This function returns library versions as provided by cmake during compilation.

Returns:

dictionary in following format: { "libName" : [ (major, minor, patchlevel) , "versionString" ] }

As an example the dict below reflects what libraries this documentation was compiled with (here are only those detected by CMAKE):

Yade [1]: from yade.libVersions import *

Yade [2]: getAllVersionsCmake()
Out[2]: 
{'cmake': [(3, 28, 3), '3.28.3'],
 'compiler': [(13, 2, 0), '/usr/bin/c++ 13.2.0'],
 'boost': [(1, 83, 0), '108300'],
 'freeglut': [(3, 0, 0), '3.0.0'],
 'python': [(3, 12, 3), '3.12.3'],
 'matplotlib': [(3, 6, 3), '3.6.3'],
 'eigen': [(3, 4, 0), '3.4.0'],
 'vtk': [(9, 1, 0), '9.1.0'],
 'suitesparse': [(7, 6, 1), '7.6.1'],
 'mpi': [(3, 1, 0), '3.1'],
 'numpy': [(1, 26, 4), '1.26.4'],
 'ipython': [(8, 20, 0), '8.20.0'],
 'sphinx': [(7, 2, 6), '7.2.6'],
 'clp': [(1, 17, 9), '1.17.9'],
 'coinutils': [(2, 11, 4), '2.11.4'],
 'mpi4py': [(3, 1, 5), '3.1.5'],
 'mpmath': [(1, 2, 1), '1.2.1'],
 'tkinter': [(8, 6, 0), '8.6'],
 'pygraphviz': [(1, 7, 0), '1.7'],
 'Xlib': [(0, 33, 0), '(0,33)']}

Note

Please add here detection of other libraries when yade starts using them or if you discover how to extract from cmake a version which I didn’t add here.

yade.libVersions.getArchitecture()

Returns:

string containing processor architecture name, as reported by uname -m call or from CMAKE_HOST_SYSTEM_PROCESSOR cmake variable.

yade.libVersions.getLinuxVersion()

Returns:

string containing linux release and version, preferably the value of PRETTY_NAME from file /etc/os-release.

yade.libVersions.getVersion(libName)

This function returns the tuple (major, minor, patchlevel) with library version number. The yade --test in file py/tests/libVersions.py tests that this version is the same as detected by cmake and C++. If only one of those could detect the library version, then this number is used.

Parameters:

libName (string) – the name of the library

Returns:

tuple in format (major, minor, patchlevel) if libName exists. Otherwise it returns None.

Note

library openblas has no properly defined version in header files, this function will return (0,0,0) for openblas. Parsing the version string would be unreliable. The mpi version detected by cmake sometimes is different than version detected by C++, this needs further investigation.

yade.libVersions.printAllVersions(rstFormat=False)

This function prints a nicely formatted table with library versions.

Parameters:

rstFormat (bool) – whether to print table using the reStructuredText formatting. Defaults to False and prints using Gitlab markdown rules so that it is easy to paste into gitlab discussions.

As an example the table below actually reflects with what libraries this documentation was compiled:

Yade [1]: printAllVersions()

```
Yade version   :  2024-11-30.git-d1890d5
Yade features  :  LOGGER USEFUL_ERRORS COMPLEX_MP VTK OPENMP GTS QT5 CGAL PFVFLOW PFVFLOW LINSOLV MPI TWOPHASEFLOW LS_DEM FEMLIKE GL2PS LBMFLOW THERMAL PARTIALSAT POTENTIAL_PARTICLES POTENTIAL_BLOCKS
Yade config dir:  ~/.config/yade-ci
Yade precision :  53 bits, 15 decimal places, with mpmath, PrecisionDouble
Yade RealHP<…> :  (15, 33, 45, 60, 120, 150, 300) decimal digits in C++, (15, 33) decimal digits accessible from python
```

Libraries used :

| library       | cmake                 | C++                 |
| ------------- | --------------------- | ------------------- |
| Xlib          | (0,33)                |                     |
| boost         | 108300                | 1.83.0              |
| cgal          |                       | 5.6                 |
| clp           | 1.17.9                | 1.17.9              |
| cmake         | 3.28.3                |                     |
| coinutils     | 2.11.4                | 2.11.4              |
| compiler      | /usr/bin/c++ 13.2.0   | gcc 13.2.0          |
| eigen         | 3.4.0                 | 3.4.0               |
| freeglut      | 3.0.0                 |                     |
| gl            |                       | 20220530            |
| ipython       | 8.20.0                |                     |
| matplotlib    | 3.6.3                 |                     |
| metis         |                       | unknown_version     |
| mpi           | 3.1                   | ompi:4.1.6          |
| mpi4py        | 3.1.5                 |                     |
| mpmath        | 1.2.1                 |                     |
| numpy         | 1.26.4                |                     |
| openblas      |                       |  OpenBLAS 0.3.26    |
| pygraphviz    | 1.7                   |                     |
| python        | 3.12.3                | 3.12.3              |
| qglviewer     |                       | 2.8.0               |
| qt            |                       | 5.15.13             |
| sphinx        | 7.2.6                 |                     |
| sqlite        |                       | 3.45.1              |
| suitesparse   | 7.6.1                 | 7.6.1               |
| tkinter       | 8.6                   |                     |
| vtk           | 9.1.0                 | 9.1.0               |

```
Linux version  :  Ubuntu 24.04.1 LTS
Architecture   :  amd64
Little endian  :  True
```

Note

For convenience at startup from yade.libVersions import printAllVersions is executed, so that this function is readily accessible.

yade._libVersions.getAllVersionsCpp() → dict

This function returns library versions as discovered by C++ during compilation from all the #include headers. This can be useful in debugging to detect some library .so conflicts.

Returns:

dictionary in folowing format: { "libName" : [ (major, minor, patch) , "versionString" ] }

As an example the dict below reflects what libraries this documentation was compiled with (here are only those detected by C++):

Yade [1]: from yade.libVersions import *

Yade [2]: getAllVersionsCpp()
Out[2]: 
{'compiler': [(13, 2, 0), 'gcc 13.2.0'],
 'boost': [(1, 83, 0), '1.83.0'],
 'qt': [(5, 15, 13), '5.15.13'],
 'gl': [(2022, 5, 30), '20220530'],
 'qglviewer': [(2, 8, 0), '2.8.0'],
 'python': [(3, 12, 3), '3.12.3'],
 'eigen': [(3, 4, 0), '3.4.0'],
 'sqlite': [(3, 45, 1), '3.45.1'],
 'vtk': [(9, 1, 0), '9.1.0'],
 'cgal': [(5, 6, 0), '5.6'],
 'suitesparse': [(7, 6, 1), '7.6.1'],
 'openblas': [(0, 0, 0), ' OpenBLAS 0.3.26 '],
 'metis': [(0, 0, 0), 'unknown_version'],
 'mpi': [(4, 1, 6), 'ompi:4.1.6'],
 'clp': [(1, 17, 9), '1.17.9'],
 'coinutils': [(2, 11, 4), '2.11.4'],
 'mpfr': [],
 'mpc': []}

Note

Please add here C++ detection of other libraries when yade starts using them.