ldmx-sw和ldmx-analysis开发环境

该容器配合一些实用别名，允许您在与计算机其他部分隔离的容器中构建和运行ldmx-sw及其相关软件，无需安装任何其他依赖。容器通过挂载文件实现与系统共享文件，使您可以继续使用原有的操作系统、文本编辑器、root版本等，而不会影响ldmx-sw的构建和运行。

设置

为了在docker容器上挂载内容，建议定义一个供您和docker容器使用的环境变量：LDMX_BASE。此环境变量的拼写和大小写必须严格如此，因为它将按名称传入docker容器。

在bash中：

bash
export LDMX_BASE=<包含ldmx-sw的目录路径>

为了在ldmx环境（容器内）中运行命令，您需要一个较长的docker命令。建议为该命令定义一个别名，因为在配置/构建/运行工作流中它不会改变。同样在bash中：

bash
alias ldmx='docker run --rm -it -e LDMX_BASE -v $LDMX_BASE:$LDMX_BASE -u $(id -u ${USER}):$(id -g ${USER}) ldmx/dev:latest $(pwd)'

命令各部分解释：

• docker：基础docker命令，您需要获得特殊权限以无需root运行docker。或者，您可以在docker前加上sudo（或系统等效命令），但每次运行都需要输入密码。
• run：运行镜像为容器（而非构建、拉取或推送镜像）
• --rm：命令完成后删除容器，自动清理（可选）
• -it：允许主机（您的计算机）向docker容器传递信号（如ctrl-C）
• -e LDMX_BASE：将当前环境中的LDMX_BASE环境变量传递到容器环境
• -v $LDMX_BASE:$LDMX_BASE：将$LDMX_BASE目录挂载到容器中的相同位置
• -u $(id -u ${USER}):$(id -g ${USER})：以当前用户及其组的权限运行docker命令
• ldmx/dev:latest：用于创建运行容器的镜像
• $(pwd)：镜像的入口点接受两个参数，第一个是容器内的目标目录，其余是要执行的命令。这部分使进入容器后切换到与主机相同的位置，确保命令在预期位置运行。传递给镜像的其余参数是该别名后的内容。

使用

完成上述设置后，即可开始进行ldmx-sw的构建、安装和运行等操作。简单理解，ldmx命令的作用是将后续命令放入docker容器中运行。由于已将工作文件挂载到容器的相同位置，容器可以访问并读写这些文件。以下是构建、安装和运行的命令示例：

bash
$ cd ldmx-sw; mkdir build; cd build
$ ldmx cmake ..
$ ldmx make -j2 install
$ ldmx ldmx-app config.py

假设

容器的基本假设是：您已正确定义LDMX_BASE环境变量，且LDMX_BASE内的文件具有特定格式：

$LDMX_BASE
├── ldmx-analysis
│   ├── install
|   |   ├── lib (安装时自动创建)
|   |   |     ├── python (安装时自动创建)
|   |   ├── bin (安装时自动创建)
│   │   ...其他代码/脚本
├── ldmx-sw
│   ├── install
|   |   ├── lib (安装时自动创建)
|   |   |     ├── python (安装时自动创建)
│   │   ...其他代码/脚本
| ...其他代码/脚本

这确保在构建/安装/运行时，容器能够找到所需的特定文件。入口点脚本用于定义ldmx运行环境，使命令能在其中运行；因此容器需要预先知道各种安装位置，以便将容器的PATH、PYTHONPATH和LD_LIBRARY_PATH指向正确目录。

注意事项

在大多数系统上，docker以root用户运行，因此其创建的任何文件都归root所有。这在某些共享系统上可能存在问题，如在共享计算资源上使用此系统，请咨询机构IT部门。此外，在个人计算机上，只有使用sudo或通过docker才能删除docker创建的文件。例如，删除之前创建的构建文件：

bash
$ cd ldmx-sw/build
$ rm -rf *
...权限被拒绝错误...
$ ldmx rm -rf * # 可行