diff --git a/docs/src/installation.rst b/docs/src/installation.rst index 88e2719..9762111 100644 --- a/docs/src/installation.rst +++ b/docs/src/installation.rst @@ -15,20 +15,20 @@ Installing the backend Packages ~~~~~~~~ -We provide binary `Ubuntu `_ and `RPM `_ packages of the latest beta and stable releases of the CARTA backend for all officially supported distributions. +We provide binary Ubuntu and RPM packages of the latest beta and stable releases of the CARTA backend for all officially supported distributions. -You can install the latest stable version with all dependencies on Ubuntu by adding our PPA to your system and running ``apt-get install carta-backend``. +You can install the latest stable version with all dependencies on Ubuntu by adding our `main PPA `_ to your system and running ``apt-get install carta-backend``. -On AlmaLinux you can add our Copr repository and run ``sudo dnf install carta-backend``. +On AlmaLinux you can add our `main Copr repository `_ and run ``sudo dnf install carta-backend``. .. note:: - The ``carta-backend`` package is updated with every stable CARTA release. If you would like to install the latest **beta** version of CARTA, or to receive beta release updates as well as stable release updates in the future, please install the ``carta-backend-beta`` package instead. + The packages in the main repositories are updated with every stable CARTA release. If you would like to install the latest **beta** version of CARTA, or to receive beta release updates as well as stable release updates in the future, please use the alternate `preview PPA `_ or `preview Copr repository `_ instead. Packaged debug symbols ~~~~~~~~~~~~~~~~~~~~~~ -You can install debugging symbols for our Ubuntu packages with ``apt`` if you enable this option for our PPA. +You can install debugging symbols for our Ubuntu packages with ``apt`` if you enable this option for our PPA (substitute the preview PPA URL as required). .. code-block:: shell @@ -47,7 +47,7 @@ Rebuilding packages Our Ubuntu package source is available in `a collection of public repositories `_. Please refer to the ``debian`` subdirectories in these repositories if you would like to build your own Debian packages, or to check what build options we use. -You can also obtain the Ubuntu package source with ``apt-src`` (after enabling source packages for our PPA). +You can also obtain the Ubuntu package source with ``apt-src`` after enabling source packages for our PPA (substitute the preview PPA URL as required). .. code-block:: shell @@ -72,7 +72,7 @@ External data for Casacore Casacore depends on a collection of external astronomical data. Some distributions provide packages for this. Because these packages may be far behind the current version of the data, you may wish to manage the required files without using a package. -The ``casacore-data`` package is recommended by the Ubuntu backend package, but installing it is optional. The packages in `our Ubuntu PPA `_ should be compatible both with the ``casacore-data`` package in the core Ubuntu repositories and with the package provided by the `Kern PPAs `_. To avoid installing the ``casacore-data`` package, use the ``--no-install-recommends`` flag when installing the backend package. +The ``casacore-data`` package is recommended by the Ubuntu backend package, but installing it is optional. The packages in our Ubuntu PPAs (`release `_ or `preview `_) should be compatible both with the ``casacore-data`` package in the core Ubuntu repositories and with the package provided by the `Kern PPAs `_. To avoid installing the ``casacore-data`` package, use the ``--no-install-recommends`` flag when installing the backend package. An example script for fetching the data manually (you can configure ``cron`` to run this weekly): @@ -111,6 +111,10 @@ Once all dependencies have been installed, check out the backend repository and The backend executable will be located in the ``build`` directory. +.. note:: + + If you are building the latest development or beta version of the backend on a recent Ubuntu or RPM-based system, you should be able to install the packaged build dependencies from the ``preview`` PPA or Copr repository. However, if you are building the latest stable release version, you should install them from the main PPA or Copr repository instead. + .. note:: If you install a custom backend, ensure that a custom ``processCommand`` is set in the controller configuration and that the backend path is updated in the sudoers file. diff --git a/docs/src/step_by_step.rst b/docs/src/step_by_step.rst index 737a921..de12fe8 100644 --- a/docs/src/step_by_step.rst +++ b/docs/src/step_by_step.rst @@ -139,14 +139,17 @@ Install CARTA backend and other required packages sudo apt-get install libpam0g .. note:: - - The ``carta-backend`` package is updated with every stable CARTA release. If you would like to install the latest **beta** version of CARTA, or to receive beta release updates as well as stable release updates in the future, please install the ``carta-backend-beta`` package instead: + + + The packages in the main PPA are updated with every stable CARTA release. If you would like to install the latest **beta** version of CARTA, or to receive beta release updates as well as stable release updates in the future, please use the alternate ``preview`` PPA instead: .. code-block:: shell - sudo apt-get install carta-backend-beta + # Add CARTA preview PPA + sudo add-apt-repository ppa:cartavis-team/carta-preview + sudo apt-get update - These packages cannot be installed simultaneously, as they use the same install locations. If you install one, you will automatically be prompted to uninstall the other. + Multiple versions of the backend package and its CASA dependency cannot be installed simultaneously. If you would like to install the release and beta backends in parallel on the same system, we recommend that you use containers. Make sure that you install the matching controller version (using the ``beta`` tag). @@ -168,9 +171,13 @@ Install CARTA backend and other required packages # Install EPEL repository sudo dnf install epel-release - # Install the CARTA backend + # Enable Copr integration sudo dnf install 'dnf-command(copr)' + + # Add the CARTA repository sudo dnf copr enable cartavis/carta + + # Install the CARTA backend sudo dnf install carta-backend # Install additional packages @@ -188,14 +195,15 @@ Install CARTA backend and other required packages Follow the prompts, and check that the default version is correct: ``python3 --version``. .. note:: - - The ``carta-backend`` package is updated with every stable CARTA release. If you would like to install the latest **beta** version of CARTA, or to receive beta release updates as well as stable release updates in the future, please install ``carta-backend-beta`` instead: + + The packages in the main Copr repository are updated with every stable CARTA release. If you would like to install the latest **beta** version of CARTA, or to receive beta release updates as well as stable release updates in the future, please use the alternate ``preview`` repository instead: .. code-block:: shell - sudo dnf install carta-backend-beta + # Add the CARTA preview repository + sudo dnf copr enable cartavis/carta-preview - We currently install the beta version of the backend package in a non-standard location, ``/opt/carta-beta``. This makes it possible to install the stable and beta packages simultaneously. When you use this package, remember to change the path to the backend executable to ``/opt/carta-beta/bin/carta_backend`` in both the sudoers file and the controller configuration. + Multiple versions of the backend package and its CASA dependency cannot be installed simultaneously. If you would like to install the release and beta backends in parallel on the same system, we recommend that you use containers. Make sure that you install the matching controller version (using the ``beta`` tag).