Install CEPC Software

Estimated reading time: 3 minutes

This page will guide you on fully installing CEPC software on the local machine.

Install CEPCEnv

CEPCEnv is a tool used for managing the installation and environment of CEPC software. In order to install CEPC software, the CEPCEnv toolkit should be installed first. Install CEPCEnv with the following command:

mkdir cepcenv
cd cepcenv
curl -sSL | sh -s
cd ..

The setup scripts and setup.csh could be found in the directory after the installation. They are used for the initialization of cepcenv command.

Initialize CEPCEnv

The initialization of CEPCEnv is necessary before using cepcenv command.

For sh/bash/zsh user, initialize CEPCEnv with:


csh/tcsh user should use:

source <CEPCENV_DIR>/setup.csh

Replace <CEPCENV_DIR> with the directory where CEPCEnv is installed.

You may want to put this command in your shell login file, e.g., $HOME/.bashrc for bash.

Install CEPC Software


Scientific Linux 6 x86_64 version is recommended. Other OSes are not fully tested and not guaranteed to work.

Please select the software root directory with enough disk space. For the first installation, there should be at least 20GB free spaces.

Available CEPC Software Versions

List all available CEPC software versions with the command:

$ cepcenv ls-remote
(Release repository: "")

Install CEPC Software

All the CEPC software packages are installed by compiling from the source. The installation command will handle the downloading and compiling automatically.

The software root will contain all the contents of CEPC software including different versions.

Install selected version:

mkdir cepcsoft
cd cepcsoft
cepcenv install <version>
cd ..

For IHEP users, the downloading could be speeded up by selecting IHEP package source:

cepcenv install --source ihep <version>

Software root could be any directory with the write access and enough space. It can be specified in the install command argument like cepcenv -r <SOFTWARE_ROOT> install 0.1.0, or in the configuration ~/.cepcenv.conf. If the software root is not specified, everything will be installed in the current directory.

The cepcenv install command will try to check whether your OS system packages meet the requirements of the installation. If there are any packages missing, you will be prompted to install them first. The root previlege is needed here. Then run the previous install command again.

Before the installation starts, you will have the chance to see the full list of the packages. If everything is OK, answer “yes” or “y” to proceed.

For a fresh installation, this could take one or more hours depending on the hardware.

Multiple versions could be installed and managed under the same software root directory. The installation of a new version could select the same software root safely.

Configure CEPC Software Root

The configuration file ~/.cepcenv.conf contains basic setups for CEPCEnv. Create this file if it does not exist:

[ -e ~/.cepcenv.conf ] || cepcenv config -e > ~/.cepcenv.conf

Edit ~/.cepcenv.conf and uncomment the software_root line:

software_root: <SOFTWARE_ROOT>

Replace <SOFTWARE_ROOT> with the root directory where the CEPC software is installed.

Setup CEPC Software Environment

Return to quick start page.

Frequently Asked Questions

  • Q: The installation is aborted accidentally. How to resume the installation process.

    A: Run the same installation command again and it will continue with the unfinished packages automatically.