Installation

Python module `pydlr`

The Python module pydlr is available on the Python Package Index (PyPi) and can be installed by running:

pip3 install pydlr

If you do not have root privileges add the flag --user to install to your home directory. Note that pydlr requires Python version 3 as well as the standard Python modules numpy and scipy.

Developer installation

If you want to contribute to the development of pydlr consider doing a “developer installation” by cloning the repo and set your PYTHONPATH environment variable manually:

cd /my/install/directory
git clone https://github.com/jasonkaye/libdlr.git
export PYTHONPATH=/my/install/directory/libdlr:$PYTHONPATH
python -c "import pydlr; print(pydlr.__file__)"

The last command is a test that the pydlr module can be found by python and should print:

/my/install/directory/libdlr/__init__.py

where /my/install/directory is your system-specific install location.

For a permanent setup, consider adding the export ... command above to the initialization script of your shell, e.g. to ~/.bashrc, ~/.profile, or similar.

The pydlr unit-tests can be run using:

cd /my/install/directory/libdlr/pydlr/test
python -m unittest

Fortran library `libdlr`

The Fortran library libdlr has the following requirements/dependencies

Fortran compiler
BLAS / LAPACK
CMake >=v3.18

Build

libdlr is using the CMake build system.

To build libdlr from source run:

git clone https://github.com/jasonkaye/libdlr.git
cd libdlr
mkdir cbuild
cd cbuild
cmake -DCMAKE_BUILD_TYPE=Release ..
make
make test
make install

Build documentation (optional)

To build the documentation locally add the CMake flags:

cmake -DCMAKE_BUILD_TYPE=Release -Dwith_python=ON -DBUILD_DOCS=ON ..

Custom install location

To install libdlr to a non-standard location, e.g. in your home directory, add the CMake flag:

-DCMAKE_INSTALL_PREFIX="/my/install/directory"

when calling cmake.

Custom Blas/Lapack

CMake will attempt to auto-detect the available BLAS libraries and LAPACK libraries.

If the auto-detection fails and you have libraries installed in custom locations, try adding your custom location in the CMake flag:

-DCMAKE_LIBRARY_PATH="/custom/path/to/blas/lapack/"

Linking with `libdlr`

With libdlr installed on your system in a standard location, linking with the library should only require using the link flag -ldlr.

When using a custom install location, the path to your installation also needs to be specified:

-L/my/install/directory/lib -ldlr

The same path also has to be present in your LD_LIBRARY_PATH environment variable at runtime.

Compiling a Fortran program which uses `libdlr`

As an example, if you wish to compile the demo sc_it.f90 using gfortran, and you have installed libdlr in a standard location, navigate to the demo folder and use the command:

gfortran sc_it.f90 -ldlr -o my_demo

If you have installed libdlr in a custom location, use the commands:

export LD_LIBRARY_PATH=/my/install/directory/lib
gfortran sc_it.f90 -L/my/install/directory/lib -ldlr -o my_demo

Support

If you experience problems installing libdlr or pydlr please consider opening an issue on our GitHub repository, or contacting us directly. All systems are different, and letting us know about your issue will help us to make the user experience more seamless in a wider variety of environments.