Skip to content

Commit

Permalink
make ubuntu 22.04 the explicit version for CoLRev
Browse files Browse the repository at this point in the history
  • Loading branch information
dengdenglele authored and geritwagner committed Jan 18, 2024
1 parent 57f2ec9 commit d60e22e
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions docs/source/dev_docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Although we only support the systems listed in the table below, useful hints for

**Supported operating systems and setup methods:**

=========== ============ ====== ============
OS/Setup Native WSL2 VirtualBox
=========== ============ ====== ============
Linux yes no yes
============ ============ ====== ============
OS/Setup Native WSL2 VirtualBox
============ ============ ====== ============
Ubuntu 22.04 yes no yes
Win 10/11 no yes yes
macOS no no yes
=========== ============ ====== ============
============ ============ ====== ============

**The setup also includes:**

Expand All @@ -23,14 +23,18 @@ Although we only support the systems listed in the table below, useful hints for
- CoLRev
- Continuous integration (pre-commit hooks)

For best performance and user experience, it is recommended to run CoLRev natively on Linux or via WSL2 on Windows.
For testing purposes or macOS, using the pre-configured virtual machine on VirtualBox is feasible, but performance is highly dependent on powerful hardware.
Windows and MacOS do not (yet) support all dependencies required by CoLRev.
For best performance and user experience, it is recommended to run CoLRev natively on a machine with Ubuntu 22.04 installed.

Windows machines can run CoLRev via WSL2 with Ubuntu 22.04 installed.
Using Ubuntu 22.04 via WSL2 does not provide the default GNOME Desktop Environment (GNOME DE).
Applications with a GUI such as gitk or VSCode can be run via commands using the CLI provided.

For testing purposes or macOS machines, using the pre-configured virtual machine on VirtualBox is feasible, but performance is highly dependent on powerful hardware.
Windows and macOS do not (yet) support all dependencies required by CoLRev.

CoLRev runs natively on **Linux** distributions and the step-by-step instructions apply to Linux systems.
They are tested for `Ubuntu 22.04.3 LTS <https://ubuntu.com/download/desktop>`__ and `Debian 11.7 “Bullseye” <https://www.debian.org/releases/bullseye/debian-installer/>`__.
Please note that current Non-LTS versions (22.10, 23.04, 23.10) of Ubuntu and Debian 12 “Bookworm” are not supported due to a change in the handling of the `pip package manager <https://itsfoss.com/install-pipx-ubuntu/>`__.
Support for newer Linux distributions is scheduled for April 2024 with the next LTS release of Ubuntu.
They are tested for `Ubuntu 22.04 “Jammy” <https://releases.ubuntu.com/jammy/>`__ and `Debian 11.7 “Bullseye” <https://www.debian.org/releases/bullseye/debian-installer/>`__.
Please note that newer versions of Ubuntu (22.10, 23.04, 23.10, 24.04) and Debian 12 “Bookworm” are not supported due to a change in the handling of the `pip package manager <https://itsfoss.com/install-pipx-ubuntu/>`__.

The last sections of the setup explain how to setup CoLRev on Windows using the WSL2 and on macOS using a Virtual Machine.

Expand Down

0 comments on commit d60e22e

Please sign in to comment.