DDFacet 0.8.0.0

（用户/推荐 - 基于 Docker）通过 Stimela >= 0.2.9 运行

我们建议通过Stimela框架运行成像软件包 <https://github.com/SpheMakh/Stimela>，该框架基于广泛支持的容器化框架Docker构建。这个软件包位于PiPY，纯Python编写，除了Docker之外无需其他依赖。它为用户提供了即时访问其他常用软件包，如Meqtrees、CASA等。

1. 从Docker PPA安装最新的Docker：<https://docs.dockerd.com.cn/engine/installation/linux/ubuntu/>。如果您不运行Debian，请选择合适的发行版。

2. 确保将您的用户添加到docker组中。在基于Debian的系统上，可以按以下方式操作

   $ sudo usermod -aG docker $USER

3. 设置虚拟环境，激活它，并将pip、setuptools和wheel升级到最新的PyPI版本

   $ virtualenv stimelavenv
   $ source stimelavenv/bin/activate
   (stimelavenv)$ pip install -U pip wheel setuptools
   (stimelavenv)$ pip install stimela

4. 运行stimela pull和stimela build以从DockerHub拉取所有最新的天文学软件（这可能需要一些时间，大小为几个GiB，所以请确保您有一个快速的连接）

   (stimelavenv)$ stimela pull
   (stimelavenv)$ stimela build

5. stimela cabs -i ddfacet列出了成像器的所有可用选项。

6. 然后，您可以将DDFacet作为更大减少脚本的一部分添加，例如

    1 import stimela
    2
    3 INPUT="input"
    4 OUTPUT="output"
    5 MSDIR="msdir"
    6
    7 recipe = stimela.Recipe("Test DDFacet imaging", ms_dir=MSDIR)
    8 # ...any other calibration steps here...
    9 recipe.add("cab/ddfacet", "ddfacet_test",
   10            {
   11                "Data-MS": ["3C147.MS/SUBMSS/D147-LO-NOIFS-NOPOL-4M5S.MS"],
   12                "Output-Name": "testimg",
   13                "Image-NPix": 2048,
   14                "Image-Cell": 2,
   15                "Cache-Reset": True,
   16                "Freq-NBand": 3,
   17                "Weight-ColName": "WEIGHT",
   18                "Beam-Model": "FITS",
   19                "Beam-FITSFile": "'beams/JVLA-L-centred_$(corr)_$(reim).fits'",
   20                "Data-ChunkHours": 0.5,
   21                "Data-Sort": True
   22            },
   23            input=INPUT, output=OUTPUT, shared_memory="14gb",
   24            label="test_image:: Make a test image using ddfacet")
   25 # ... any post imaging / additional calibration steps here ...
   26 recipe.run()

7. 使用以下命令运行脚本

   (stimelavenv)$ stimela run myscriptname.py

8. 完成成像业务后，请取消激活虚拟环境

   (stimelavenv)$ deactivate

（用户/PyPI替代）虚拟环境和pip

我们希望用户通过Docker使用DDFacet。然而，如果这不可用（例如集群环境），我们建议您使用虚拟环境。如果您将其直接安装到系统软件包中，那么您将自行负责——警告！！

警告：如果您之前已在环境中安装了numpy，可能会遇到问题——如果安装的numpy版本早于在隔离过程中拉取的构建系统版本，则构建隔离将失败。您可能需要在安装时使用–no-build-isolation，或者更好的方法是确保在空的新虚拟环境中安装DDF和KillMS。

1. 安装每个Debian依赖项。最新的apt依赖项完整列表可以在Dockerfile <https://github.com/saopicc/DDFacet/blob/master/docker.2204>中找到

2. 在您的系统上的某个位置创建虚拟环境并激活它

   virtualenv ddfacet
   source ddfacet/bin/activate

3. 然后，使用pip直接从Python包索引（PyPI）安装 - 确保您的venv已激活

   pip install -U pip
   pip install DDFacet

5. 完成成像业务后

   deactivate

（用户/可选）FitsBeam、Montblanc、Moresane、Killms支持

可选要求，如FITS波束，可以通过在括号中指定它们来安装。例如，pip install “/src/DDFacet/[dft-support,moresane-support,testing-requirements,fits-beam-support,kms-support]”

（用户/故障排除）配置最大共享内存

在大型图像上运行DDFacet需要大量的共享内存。大多数系统将共享内存限制在大约10%。要增加此限制，请将以下行添加到您的/etc/default/tmpfs文件中

SHM_SIZE=100%

此更改需要重新启动才能生效。如果您希望一次性解决，请执行以下命令

sudo mount -o remount,size=100% /run/shm

可能还需要运行以下命令以移除mlock pinning的内核安全限制。否则，速度可能比平时慢

echo "*        -   memlock     unlimited" > /etc/security/limits.conf

（开发者/注意）：架构相关二进制文件

默认构建系统配置不会产生可移植的二进制文件，这会略微提高运行时间。您必须在编译软件包之前修改pyproject.toml并设置以下行

` cmake.define = {ENABLE_NATIVE_TUNING = "ON", ENABLE_FAST_MATH = "ON", ENABLE_PYTHON_2 = "OFF", ENABLE_PYTHON_3 = "ON"} `

（开发者/推荐）：设置您的开发环境

注意：请按照上面用户部分中指定的方式设置您的虚拟环境。确保您激活了！ 警告：如果您之前在该环境中安装了numpy，可能会遇到问题 - 构建隔离 如果您的numpy版本比构建系统在隔离过程中拉取的版本旧，构建将失败。 您可能需要在使用时使用–no-build-isolation选项，甚至更好的方法是确保您在一个全新的虚拟环境中安装DDF和KillMS。

要设置您的本地开发环境，请克隆DDFacet并运行

(ddfvenv) $ git clone https://github.com/cyriltasse/DDFacet
(ddfvenv) $ pip install -e DDFacet/

重要提示：在安装时，您可能需要先删除开发版本，然后再运行PIP。如果您 在后台版本的发布和调试版本之间切换 - 或者在不同的配置下重新编译 - 应该删除DDFacet/DDFacet/cbuild目录及其所有内容

请注意，Python3.8的支持已被弃用，并且可编辑的安装仅在Python 3.10上进行了测试。

(开发者/测试) 基于Docker的构建

1. 简单地拉取最新的DDFacet并构建Docker镜像

   git clone git@github.com:cyriltasse/DDFacet.git
   cd DDFacet
   docker build -t ddf -f docker.2204 .

2. 现在您应该能够在容器中运行DDFacet。请注意，您的parsets必须具有相对于容器内挂载卷的相对文件名，例如

   docker run --shm-size 6g -v /scratch/TEST_DATA:/mnt ddf /mnt/test-master1.parset

重要：如果您在构建Docker镜像之前运行了“git submodule update –init –recursive”，则可能需要删除缓存的SkyModel，可以使用“git rm –cached SkyModel”

(开发者/调试) 构建一些库（通过手动使用自定义标志）

您可以对库的定制版本进行构建，例如libPython和定制的numpy版本。为此，修改pyproject.toml。找到并修改以下行:: ` cmake.build-type = "ReleaseWithDebugSymbols" # 可以设置为 Debug e.g. cmake.define = {ENABLE_NATIVE_TUNING = "OFF", ENABLE_FAST_MATH = "ON", ENABLE_PYTHON_2 = "OFF", ENABLE_PYTHON_3 = "ON"} # 可以调整以启用处理器特定的优化 ` 您还可以通过这些 `cmake.define` 指定其他库的路径设置，如果您已经自定义构建了，例如通过这些 `cmake.define`

(开发者/验收测试)

export DDFACET_TEST_DATA_DIR=[folder where you keep the acceptance test data and images]
export DDFACET_TEST_OUTPUT_DIR=[folder where you want the acceptance test output to be dumped]