Merge pull request #969 from slaclab/pre-release

Release Candidate For V6.1.0

docs/src/installing/anaconda.rst

@@ -17,8 +17,8 @@ Go to https://www.anaconda.com/download to get the latest version of anaconda. E
 
 .. code::
 
-   $ wget https://repo.anaconda.com/archive/Anaconda3-2023.03-1-Linux-x86_64.sh
-   $ bash Anaconda3-2023.03-1-Linux-x86_64.sh
+   $ wget https://repo.anaconda.com/archive/Anaconda3-{version}-Linux-x86_64.sh
+   $ bash Anaconda3-{version}-Linux-x86_64.sh
 
 You do not need to install visual studio.
 
@@ -32,6 +32,7 @@ It is important to use the latest conda solver:
 
 .. code::
 
+    $ conda activate
     $ conda config --set channel_priority strict
     $ conda install -n base conda-libmamba-solver
     $ conda config --set solver libmamba
@@ -53,17 +54,11 @@ If you already have an anaconda environment that you would like to install Rogue
 
    $ conda install -c tidair-tag -c conda-forge rogue
 
-The above commands will install the latest version of Rogue from the `main` branch. If you want to install the `pre-release` version of Rogue, run the following:
-
-.. code::
-
-   $ conda create -n rogue_dev -c tidair-dev -c conda-forge rogue
-
 Alternatively you can install a specific released version of Rogue:
 
 .. code::
 
-   $ conda create -n rogue_v5.18.4 -c conda-forge -c tidair-tag rogue=v5.18.4
+   $ conda create -n rogue_v6.0.0 -c conda-forge -c tidair-tag rogue=v6.0.0
 
 Using Rogue In Anaconda
 =======================
@@ -76,7 +71,7 @@ To activate:
 
    $ conda activate rogue_tag
 
-Replace rogue_tag with the name you used when creating your environment (rogue_dev or rogue_5.8.0).
+Replace rogue_tag with the name you used when creating your environment (e.g. rogue_v6.0.0).
 
 
 To deactivate:
@@ -100,8 +95,6 @@ If you want to update Rogue, run the following command after activating the Rogu
 
    $ conda update rogue -c tidair-tag
 
-Replace tidair-tag with tidair-dev for pre-release
-
 Deleting Anaconda Environment
 =============================
 

docs/src/installing/anaconda_build.rst

@@ -5,57 +5,47 @@ Building Rogue Inside Anaconda
 ==============================
 
 This section provides instructions for downloading and building rogue inside an anaconda environment. These
-instructions are relevant for Linux, Ubuntu on Windows and MacOS.
-
-See MacOS section at the bottom for additional steps required for building rogue in MacOS.
-
-See the section :ref:`installing_windows` for additional steps required for Windows.
+instructions are relevant for Linux
 
 Getting Anaconda
 ================
 
-Download and install anaconda (or miniconda) if you don't already have it installed on your machine. Choose an install location with a lot of available diskspace (> 5GB). Anaconda appears to only work reliably in the bash shell. 
+Download and install anaconda (or miniconda) if you don't already have it installed on your machine. Choose an install location with a lot of available diskspace (> 5GB). Anaconda appears to only work reliably in the bash shell.
 
 Go to https://www.anaconda.com/download to get the latest version of anaconda. Example steps for installing anaconda are included below:
 
 .. code::
 
-   $ wget https://repo.anaconda.com/archive/Anaconda3-5.3.0-Linux-x86_64.sh
-   $ bash Anaconda3-5.3.0-Linux-x86_64.sh
-
-You do not need to install visual studio.
+   $ wget https://repo.anaconda.com/archive/Anaconda3-{version}-Linux-x86_64.sh
+   $ bash Anaconda3-{version}-Linux-x86_64.sh
 
 Use the following command to add anaconda to your environment. This can be added to your .bash_profile.
 
 .. code::
 
    $ source /path/to/my/anaconda3/etc/profile.d/conda.sh
 
+Set your local anaconda to use the update solver:
+
+.. code::
+
+    $ conda activate
+    $ conda config --set channel_priority strict
+    $ conda install -n base conda-libmamba-solver
+    $ conda config --set solver libmamba
+
 Downloading Rogue & Creating Anaconda Environment
 =================================================
 
 The next step is to download rogue and create a rogue compatible anaconda environment.
 
 .. code::
 
-   $ conda activate
-   $ conda install git
    $ git clone https://github.com/slaclab/rogue.git
    $ cd rogue
-
-For Linux:
-
-.. code::
-
+   $ conda activate
    $ conda env create -n rogue_build -f conda.yml
 
-For MacOS:
-
-.. code::
-
-   $ conda env create -n rogue_build -f conda_mac.yml
-
-
 You now have an anaconda environment named rogue_build which contains all of the packages required to build and run rogue.
 
 To activate this environment:
@@ -77,7 +67,7 @@ Once the rogue environment is activated, you can build and install rogue
    $ make
    $ make install
 
-The Rogue build system will automatically detect that it is in a conda environment and it will be installed 
+The Rogue build system will automatically detect that it is in a conda environment and it will be installed
 within the anaconda rogue environment.
 
 Using Rogue In Anaconda
@@ -122,20 +112,3 @@ Run the following commands to delete the anaconda environment.
 
    $ conda env remove -n rogue_build
 
-Special Steps For MacOS
-=======================
-
-In order to compile rogue in MacOS you first need to download an install an older version of the MacOS SDK
-
-.. code::
-
-   $ git clone https://github.com/phracker/MacOSX-SDKs
-   $ sudo mv MacOSX-SDKs/MacOSX10.9.sdk /opt/
-
-You must set the following environment variables to setup anaconda in build mode before creating and activating the rogue environment.
-
-.. code::
-
-   $ export CONDA_BUILD_SYSROOT=/opt/MacOSX10.9.sdk
-   $ export CONDA_BUILD=1
-

docs/src/installing/build.rst

@@ -5,7 +5,7 @@ Building Rogue From Source
 ==========================
 
 The following instructions demonstrate how to build rogue outside of the anaconda environment. These
-instructions are only relevant for the Linux and MacOS operating systems. See :ref:`installing_anaconda` or
+instructions are only relevant for the Linux operating systems. See
 :ref:`installing_docker` for Windows and MacOS.
 
 Installing Packages Required For Rogue
@@ -50,25 +50,6 @@ archlinux:
    $ pacman -S zeromq
    $ pacman -S python-pyqt5
 
-MacOs:
-#######
-
-Information on the homebrew package manager can be found at: `<https://brew.sh/>`_
-
-.. code::
-
-   $ brew install cmake
-   $ brew install python3
-   $ brew install boost
-   $ brew install bzip2
-   $ brew install python-pip
-   $ brew install git
-   $ brew install zeromq
-   $ brew install pyqt5
-
-Epics V3 support is and optional module that will be included in the rogue build
-if the EPICS_BASE directory is set in the user's environment.
-
 Building & Installing Rogue
 ===========================
 

docs/src/installing/petalinux.rst

@@ -18,23 +18,24 @@ You will want to replace the file project-spec/meta-user/recipes-apps/rogue/rogu
 
 .. code::
 
-   ROGUE_VERSION = "5.18.2"
-   ROGUE_MD5SUM  = "38bf1bc4108eb08fc56ee9017be40c50"
-
+   ROGUE_VERSION = "6.0.0"
+   ROGUE_MD5SUM  = "42d6ffe9894c10a5d0e4c43834878e73"
+   
    SUMMARY = "Recipe to build Rogue"
    HOMEPAGE ="https://github.com/slaclab/rogue"
    LICENSE = "MIT"
    LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
-
+   
    SRC_URI = "https://github.com/slaclab/rogue/archive/v${ROGUE_VERSION}.tar.gz"
    SRC_URI[md5sum] = "${ROGUE_MD5SUM}"
-
+   
    S = "${WORKDIR}/rogue-${ROGUE_VERSION}"
    PROVIDES = "rogue"
    EXTRA_OECMAKE += "-DROGUE_INSTALL=system -DROGUE_VERSION=v${ROGUE_VERSION}"
 
+   # Note: distutils3 is depreciated in petalinux 2023.1 and need to switch to setuptools3
    inherit cmake python3native distutils3
-
+   
    DEPENDS += " \
       python3 \
       python3-native \
@@ -51,7 +52,7 @@ You will want to replace the file project-spec/meta-user/recipes-apps/rogue/rogu
       boost \
       cmake \
    "
-
+   
    RDEPENDS:${PN} += " \
       python3-numpy \
       python3-pyzmq \
@@ -63,22 +64,20 @@ You will want to replace the file project-spec/meta-user/recipes-apps/rogue/rogu
       python3-json \
       python3-logging \
    "
-
+   
    FILES:${PN}-dev += "/usr/include/rogue/*"
    FILES:${PN} += "/usr/lib/*"
-
-   do_configure() {
+   
+   do_configure:prepend() {
       cmake_do_configure
       bbplain $(cp -vH ${WORKDIR}/build/setup.py ${S}/.)
+      bbplain $(sed -i "s/..\/python/python/" ${S}/setup.py)
    }
-
-   do_install() {
+   
+   do_install:prepend() {
       cmake_do_install
-      distutils3_do_install
    }
 
-
-
 Update the ROGUE_VERSION line for an updated version when appropriate (min version is 5.6.1). You will need to first download the tar.gz file and compute the MD5SUM using the following commands if you update the ROGUE_VERSION line:
 
 .. code::