Installation

Cloning the repository

You can clone with SSH if you have configured your SSH keys:

# Clone bluemira
sudo apt-get install git
git clone git@github.com:Fusion-Power-Plant-Framework/bluemira.git
cd bluemira

Otherwise, you can clone with HTTPS:

# Clone bluemira
sudo apt-get install git
git clone https://github.com/Fusion-Power-Plant-Framework/bluemira.git
cd bluemira

Note

If you are going to be developing bluemira, it is best to set yourself up via SSH.

Setting up the environment and installing

Bluemira can be installed into a conda environment using miniforge by running the following steps in a mac or Ubuntu command terminal.

If you are using WSL please see the additional instruction step.

# Install curl if its not available (eg vanilla Ubuntu 22.04)
sudo apt install -y curl gettext-base
# Run the conda installation script
# This installs miniforge, if not already present, and sets up a bluemira environment
bash scripts/install-conda.sh
# To activate conda's base environment
source ~/.miniforge-init.sh
# To activate your bluemira environment
conda activate bluemira

# If you are going to be developing bluemira
python -m pip install --no-cache-dir -e .'[dev]'
pre-commit install -f

When you want to activate your bluemira environment after closing your terminal (or after conda deactivate) then you can initialise miniforge and activate your bluemira environment by running:

source ~/.miniforge-init.sh
conda activate bluemira

This may result in a(n otherwise harmless) warning about overwriting variable {'LANG'}. To disable this warning and for any other issues, please refer to our FAQ for solutions.

Installing PROCESS

PROCESS is a 0D-1D fusion systems code. More information on PROCESS can be found in thier documentation here and git repository. Bluemira is able perform a PROCESS run as the initial step in the reactor design.

Install PROCESS in your bluemira environment by running the following:

pip install -e.'[process]'