Installing Rogue With Miniforge

A pre-built Rogue package can be installed into a Miniforge environment. This is the simplest way to get a working Rogue installation on Linux or on Ubuntu running under Windows WSL2.

Use this when:

  • You do not need to modify Rogue itself,

  • You want the fastest path to a usable environment,

  • Or you want dependency management handled by Miniforge.

Windows installations require Ubuntu under WSL2. See Setting Up Ubuntu On Windows.

For macOS arm64, the preferred path is to build from source inside Miniforge using Building Rogue Inside Miniforge.

Instructions for S3DF setup are also available on Confluence.

Getting Miniforge

Download and install Miniforge if you do not already have it installed. Choose an install location with adequate free disk space, typically more than 5 GB. Miniforge generally works best from a Bash shell.

Linux

$ wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh
$ bash Miniforge3-Linux-x86_64.sh

Use the following command to add Miniforge to your shell environment. This can be added to your .bash_profile.

$ source /path/to/my/miniforge3/etc/profile.d/conda.sh

It is important to use the current Conda solver:

$ conda activate
$ conda config --set channel_priority strict
$ conda install -n base conda-libmamba-solver
$ conda config --set solver libmamba

Creating A Rogue Environment

The next step is to create a Miniforge environment that includes the Rogue package.

$ conda create -n rogue_tag -c conda-forge slac-rogue

Rogue is published on conda-forge under the package name slac-rogue.

If you already have a Miniforge environment and want to install Rogue into it:

$ conda install -c conda-forge slac-rogue

Alternatively you can install a specific released version of Rogue:

$ conda create -n rogue_v6.16.0 -c conda-forge slac-rogue=6.16.0

Releases older than v6.15.0 are not on conda-forge. See Legacy tidair-tag Channel.

Using Rogue In Miniforge

No additional setup script is needed inside a Miniforge environment. Activate and deactivate the environment with the usual Conda commands:

To activate:

$ conda activate rogue_tag

Replace rogue_tag with the environment name you chose, such as rogue_v6.16.0.

To deactivate:

$ conda deactivate

Installing Rogue In Existing Environment

The following command installs Rogue into an existing Miniforge environment:

$ conda activate my_existing_env
$ conda install -c conda-forge slac-rogue

Updating Rogue In Miniforge

If you want to update Rogue, run the following command after activating the environment:

$ conda update -c conda-forge slac-rogue

Deleting Miniforge Environment

Run the following command to delete the Miniforge environment.

$ conda env remove -n rogue_tag

Legacy tidair-tag Channel

Releases older than v6.15.0 were published only to the tidair-tag Anaconda channel. There the package is named rogue and versions carry a v prefix. To install one of these older releases:

$ conda create -n rogue_v6.5.0 -c conda-forge -c tidair-tag rogue=v6.5.0

Environments created from tidair-tag contain the rogue package rather than slac-rogue, so conda update -c conda-forge slac-rogue does not upgrade them. Create a new environment to switch to the conda-forge package.