Skip to content

platforms.rst

Latest commit

 

History

History
163 lines (103 loc) · 4.78 KB

platforms.rst

File metadata and controls

163 lines (103 loc) · 4.78 KB

Reference test platforms

The following sections describe the reference platforms for the project.

Note

The officially supported Python versions are 3.8, 3.9 and 3.10. However, the project should work on any earlier Python 3 version.

The officially supported Qt binding is PyQt5. However, efforts have been made and will continue to be made to support PyQt6 and PySide6 as well.

The project is currently tested on the following platforms:

  • Microsoft Windows 10 (64-bit)
  • CentOS Stream 8.8 (64-bit)

However, it should work on any other platform supported by its dependencies.

About requirements

The requirements.txt mentioned in the following sections is a text file which contains the list of all the Python packages required for building up the projet environment. It is used by the pip command to install all the dependencies.

The requirements.txt file is generated automatically by the toml-to-requirements tool. It is based on the pyproject.toml file which is the reference file for the project dependencies.

Warning

Please note that the generation is not systematic and the requirements.txt file may not be up-to-date.

To update the requirements.txt file, you need to install the toml-to-requirements and execute the following command:

toml-to-req --toml-file .\pyproject.toml --include-optional

Microsoft Windows 10

First, install the latest version of Python 3.10 from the WinPython project.

Note

At the time of writing, the latest version is 3.10.11.1 which can be download from here.

Then install all the requirements using the following command from the WinPython command prompt:

pip install -r requirements.txt

Finally, build the Cython and C++ extensions using the following command (at this stage, you may need to install the Microsoft Visual C++ Build Tools):

python setup.py build_ext --inplace

That's it, you can now run the tests using the following command:

pytest plotpy

If you want to rely on Visual Studio Code for editing and take advantage of the project settings and tasks, you will need to set the following environment variable:

set PPSTACK_PYTHONEXE=C:\WPy64-31110\python-3.11.1.amd64\python.exe

CentOS Stream 8.8

Note

The following instructions have been tested on CentOS Stream which is the reference platform for the project. However, they should work on any other Linux distribution relying on the yum package manager. As for the other distributions, you may need to adapt the instructions to your specific environment (e.g. use apt-get instead of yum).

First, install the prerequisites:

sudo yum install groupinstall "Development Tools" -y
sudo yum install openssl-devel.i686 libffi-devel.i686 bzip2-devel.i686 sqlite-devel -y

Check that gcc is installed and available in the PATH environment variable:

gcc --version

Install OpenSSL 1.1.1:

wget https://www.openssl.org/source/openssl-1.1.1v.tar.gz
tar -xvf openssl-1.1.1v.tar.gz
cd openssl-1.1.1v
./config --prefix=/usr --openssldir=/etc/ssl --libdir=lib no-shared zlib-dynamic
make
sudo make install
openssl version
which openssl
cd ..

Install Python 3.10.13 (the latest 3.10 version at the time of writing):

wget https://www.python.org/ftp/python/3.10.13/Python-3.10.13.tgz
tar -xvf Python-3.10.13.tgz
cd Python-3.10.13
./configure --enable-optimizations --with-openssl=/usr --enable-loadable-sqlite-extensions
sudo make altinstall
cd ..

Eventually add the /usr/local/bin directory to the PATH environment variable if Python has warned you about it:

sudo echo 'pathmunge /usr/local/bin' > /etc/profile.d/py310.sh
chmod +x /etc/profile.d/py310.sh
. /etc/profile  # or logout and login again (reload the environment variables)
echo $PATH  # check that /usr/local/bin is in the PATH

Create a virtual environment and install the requirements:

python3.10 -m venv plotpy-venv
source plotpy-venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

Finally, build the Cython and C++ extensions using the following command:

cd ~/path_to_plotpy_repo
python setup.py build_ext --inplace

That's it, you can now run the tests using the following command:

pytest plotpy