notes/INSTALL_ANDROID.md

   1 # Installing QPMS on Android/AOSP (-based) systems
   2
   3 Yes, it is possible. Basically all you need is a device capable of running [Termux](https://termux.com/) with enough memory to build everything.
   4
   5 The following instructions have been tested with Termux version 0.118.0 on
   6 [e/OS/ R development build on a Samsung Galaxy S10e](https://doc.e.foundation/devices/beyond0lte/install)
   7 ([e-1.0-r-20220526188878-dev-beyond0lte](https://images.ecloud.global/dev/beyond0lte/)).
   8 Presumably, they should work also on stock Android as well, but who
   9 in their right mind would run all the spyware by Google & al.?
  10
  11 Physical keyboard or [remote access](https://wiki.termux.com/wiki/Remote_Access) is strongly recommended. :D
  12
  13 ## Get Termux
  14
  15 Just [install the Termux app from F-Droid or Github as per instructions](https://github.com/termux/termux-app#f-droid).
  16
  17 Open Termux; the following steps of these instructions are basically
  18 just commands you need to type in Termux.
  19
  20 ## Install prerequisities from termux repositories
  21
  22 ```
  23 pkg install python3 cmake git clang build-essential binutils
  24 ```
  25
  26 ## Build and install GSL
  27
  28 ```
  29 curl -O https://www.nic.funet.fi/pub/gnu/ftp.gnu.org/pub/gnu/gsl/gsl-latest.tar.gz
  30 tar xf gsl-latest.tar.gz
  31 cd gsl-2.7.1
  32 ./configure --prefix=$PREFIX
  33 make    # add -j4 or so to make it faster on multicore systems
  34 make install
  35 cd -
  36 ```
  37
  38 ## Build and install OpenBLAS
  39
  40 ```
  41 git clone https://github.com/xianyi/OpenBLAS.git
  42 cd OpenBLAS
  43 make
  44 make PREFIX=$PREFIX install
  45 cd -
  46 ```
  47
  48 ### Workaround for "broken" setup.py script
  49
  50 The goal is to fix `setup.py` so that it finds the correct libraries automatically, but in the meantime, you can use this workaround to get the Python part of QPMS installed:
  51
  52 ```
  53 ln -s $PREFIX/lib/libopenblas.so $PREFIX/LIB/liblapacke.so
  54 ```
  55
  56 ## Build and install Numpy
  57
  58 (Successful build requires the `MATHLIB` environmental variable set, otherwise linking will fail; see https://wiki.termux.com/wiki/Python.)
  59
  60 ```
  61 MATHLIB=m pip3 install numpy
  62 ```
  63
  64 ### Install Sympy
  65
  66 ```
  67 pip3 install sympy
  68 ```
  69
  70 ## Build and install QPMS
  71
  72 ```
  73 git clone https://repo.or.cz/qpms.git
  74 cd qpms
  75 cmake -DCMAKE_INSTALL_PREFIX=$PREFIX . # ugly, TODO make a separate build tree!
  76 make install
  77
  78 python3 setup.py install
  79 ```
  80
  81 Hopefully, QPMS has installed successfully. At this point, you should be able
  82 to import and use QPMS with some exceptions. First, there is some legacy code
  83 in the `qpms.qpms_p` module (which is no longer imported automatically with
  84 bare `import qpms`). You shouldn't need this unless you are trying to run some
  85 historic Jupyter notebooks or other old custom scripts. It contains a scipy
  86 dependence, and scipy is hard to get working in Android environment (as
  87 it requires a Fortran compiler to build).
  88
  89 ## Install matplotlib
  90
  91 If you try to run just `pip3 install matplotlib` in Termux, it might likely
  92 fail when installing the `pillow` dependency.
  93 First, according to [Termux wiki](https://wiki.termux.com/wiki/Python#Python_module_installation_tips_and_tricks),
  94 pillow depends on `libpng` and `libjpeg-turbo`, which are fortunately
  95 available in Termux packages.
  96 Second, pillow instalation requires an additional environment variable
  97 `LDFLAGS="-L/system/lib64"` to be set on 64-bit devices.
  98
  99 Hence:
 100 ```
 101 pkg install libpng libjpeg-turbo
 102 export LDFLAGS="-L/system/lib64" # on 64-bit devices
 103 pip3 install matplotlib
 104 ```
 105
 106 After this step, you should be able to run the command-line scripts
 107 from `misc/` directory and examples from `examples/` directory.