caracal 1.1.4

CARACal

CARACal代表容器化自动射电天文校准，是一个射电干涉测量数据降级的管道

主网站： caracal.rtfd.io

它包括以下描述的安装和运行说明，以及更多内容。

安装 & 运行

安装

我们强烈推荐并描述了使用 Python3 虚拟环境的安装方法。除非您知道自己在做什么，否则请勿在虚拟环境外尝试。以下描述中出现的任何名称 ${name} 都可以任意选择。如果它表示目录或文件，则这些目录或文件应存在，并且用户应具有 写入 权限。

有三种（3）可用的方法来安装 caracal 管道

$ python3 -m venv ${caracal-venv}

virtualenv -p python3 ${caracal-venv}
source ${caracal-venv}/bin/activate
pip install -U pip setuptools wheel

pip install -U caracal

pip install -U caracal[all]

pip install -U 'caracal[all] @ git+https://github.com/caracal-pipeline/caracal.git@master'

caratekit.sh -ws ${workspace} -cr -di -ct ${caracal_dir} -rp install -f -kh

caratekit.sh -ws ${workspace} -cr -si -ct ${caracal_testdir} -rp install -f -kh

pip install poetry

poetry install --extras all

在 (ILIFU) slurm 环境上的安装

在 Ubuntu 20.0 操作系统上已尝试和测试了 CARACal 在 ilifu 上的安装，尽管它也应该在其他 OS 版本上工作。在登录节点上，按照以下说明操作

cd /path/to/working/area
module add python/3.9.4
python3 -m venv <venv-name>
source <venv-name>/bin/activate
pip install -U pip setuptools wheel
git clone https://github.com/caracal-pipeline/caracal.git
pip install -U -e caracal
deactivate

其中 /path/to/working/area 是您希望安装 CARACal 的目录的实际路径。原则上，这也可以在 ILIFU 的 Slurm 环境中通过提交一个 sbatch 脚本来完成。请根据上述说明，在必要时修改您的 pip install 命令，并添加 [all] 选项。使用以下命令安装最新版本

pip install -U caracal

注意：CARACal 所需的 stimela singularity 镜像存储在此位置：/software/astro/caracal/，您可以从此处访问最新版本的镜像，例如，/software/astro/caracal/STIMELA_IMAGES_1.7.0。

运行

如果您手动安装了 CARACal，请使用以下命令激活虚拟环境

source ${caracal-venv}/bin/activate

如果您使用 caratekit.sh 脚本安装了 CARACal，请使用以下命令激活虚拟环境

source ${workspace}/${caracal_dir}/caracal_venv/bin/activate

如果使用 Docker 运行 CARACal

caracal -c ${your-configuration-file}

如果使用 Singularity 运行 CARACal

caracal -ct singularity -c ${your-configuration-file}

有关更详细的安装说明、故障排除技巧和完整用户手册，请参阅 caracal.readthedocs.io。

新问题

我们鼓励遇到安装或运行 CARACal 问题的人检查已知问题或在我们的 GitHub 问题页面 上新建问题。

在新建问题时，请包括以下内容

1. 安装类型（例如，Docker，Singularity）

2. 软件版本（CARACal 和 Stimela 都需要）

3. CARACal 配置文件

4. CARACal 日志文件。

如果您不是进行全新安装，请使用以下命令删除早期的 Stimela 图像：

stimela clean -ac

然后，如果您使用 Docker

stimela pull

如果您使用 Singularity，请选择一个拉取文件夹 ${singularity_pull_folder}，其中存储了 Singularity 图像，并在您的 shell 的 rc 文件（例如 .bashrc）中添加以下内容以定义一个环境变量：

export SINGULARITY_PULLFOLDER=${WORKSPACE_ROOT}/singularity_images

然后运行

stimela pull -s

如果您使用 Podman

stimela pull -p

许可证

本项目采用 GNU 通用公共许可证 v2.0 许可 - 有关详细信息，请参阅 许可证。

贡献

我们始终欢迎贡献！请确保您遵守我们的编码标准 pep8。