Firedrake 安装

参考 Install Docker Engine on Ubuntu

安装后需要启动 docker 守护进程, 由于 WSL 中的 Ubuntu 不是使用 systemd 启动的, 使用下面第一种方式会显示如下错误:

System has not been booted with systemd as init system (PID 1). Can't operate.
Failed to connect to bus: Host is down

所以我们在 WSL 中需要使用第二种方式启动 Docker 守护进程.

1. Ubuntu

   sudo systemctl start docker

2. Ubuntu in WSL

   sudo service docker start

请参考 https://yeasy.gitbook.io/docker_practice/install/mac

Firedrake 官方构建完整的镜像 firedrakeproject/firedrake 发布在 docker hub (https://hub.docker.com/), 以及支持 jupyter notebook 的镜像 firedrakeproject/firedrake-notebooks. 我们下载这些镜像, 然后运行即可使用.

下载镜像我们直接使用 docker pull 命令即可, 示例如下:

1. 下载 firedrakeproject/firedrake

   docker pull firedrakeproject/firedrake

2. 下载 firedrakeproject/firedrake-notebooks

   docker pull firedrakeproject/firedrake-notebooks

开始学习使用建议下载 firedrakeproject/firedrake-notebooks 镜像, 我们将在后面详述如何运行镜像.

在编程中, 我们可能需要一些镜像中未安装的软件包, 此时我们就需要定制镜像了, 可以基于 firedrake 的镜像构建新的镜像, 添加一些新的功能.

1. 新建目录 firedrake-jupyter

   mkdir  firedrake-jupyter
   cd firedrake-jupyter

2. 新建文件 Dockerfile.jupyter, 内容如下:

   # DockerFile for a firedrake + jupyter container
   
   FROM firedrakeproject/firedrake
   
   # This file was modefied by Zongze Yang (yangzongze@gmail.com) 
   # based on `https://github.com/firedrakeproject/firedrake/blob/master/docker/Dockerfile.jupyter`
   # # The original DockerFile is looked after by
   # # MAINTAINER David Ham <david.ham@imperial.ac.uk>
   
   USER firedrake
   
   WORKDIR /home/firedrake
   WORKDIR /home/firedrake
   # Install an iPython kernel for firedrake
   RUN bash -c ". /home/firedrake/firedrake/bin/activate && pip install jupyterhub jupyterlab ipykernel notebook ipywidgets mpltools nbformat nbconvert"
   RUN bash -c ". /home/firedrake/firedrake/bin/activate && jupyter nbextension enable --py widgetsnbextension --sys-prefix"
   
   # Install jupyterlab and tqdm
   RUN bash -c ". /home/firedrake/firedrake/bin/activate && pip install tqdm"
   
   # Remove the install log.
   RUN bash -c "rm firedrake-*"
   # Put the notebooks in the working directory for the notebook server.
   RUN bash -c "cp -r firedrake/src/firedrake/docs/notebooks/* ."
   # Strip the output from the notebooks.
   RUN bash -c '. /home/firedrake/firedrake/bin/activate && for file in *.ipynb; do jupyter nbconvert --ClearOutputPreprocessor.enabled=True --inplace $file; done'
   
   # Now do the same for thetis.
   RUN bash -c "mkdir thetis"
   RUN bash -c "cp -r firedrake/src/thetis/demos/* thetis/."
   RUN bash -c "rm thetis/*.py"
   RUN bash -c '. /home/firedrake/firedrake/bin/activate && for file in thetis/*.ipynb; do jupyter nbconvert --ClearOutputPreprocessor.enabled=True --inplace $file; done'
   
   # Environment required for Azure deployments.
   ENV OMPI_MCA_btl=tcp,self
   ENV PATH=/home/firedrake/firedrake/bin:$PATH
   
   CMD /home/firedrake/firedrake/bin/jupyter-lab --ip 0.0.0.0 --no-browser --allow-root

3. 构建镜像

   docker build --tag <tag-of-the-container> -f Dockerfile.jupyter .

   比如我给这个镜像打的标签为 lrtfm/firedrake-jupyter 那么命令为

   docker build --tag lrtfm/firedrake-jupyter -f Dockerfile.jupyter .

   该镜像已上传至 docker hub, 可以使用上一节介绍的下载命令下载:

   docker pull lrtfm/firedrake-jupyter

我们上面下载的 firedrakeproject/firedrake 就是镜像. 可以通过 docker image ls 查看所有镜像.

$ docker image ls
REPOSITORY                   TAG       IMAGE ID       CREATED          SIZE
lrtfm/firedrake-jupyter      latest    fb4c8a8d87a2   29 minutes ago   5.74GB
lrtfm/firedrake-jupyter      test      b88daa690a72   9 hours ago      5.82GB
firedrakeproject/firedrake   latest    203cb66fd620   2 days ago       5.64GB
spack/tutorial               latest    ae1b12514068   12 months ago    8.94GB
hello-world                  latest    bf756fb1ae65   19 months ago    13.3kB

像运行程序一样, 我们使用 docker run 可以通过一个镜像创建一个新的容器

$ docker run -ti  firedrakeproject/firedrake

它的输出如下, 表明我们进入了 容器 的环境中, 这里已经可以运行 firedrake 的程序了.

To run a command as administrator (user "root"), use "sudo <command>".
See "man sudo_root" for details.

firedrake@7223f8b352bd:~$

输入 exit 即可退出这个环境.

类似的, 可以通过 docker container ls 查看所有容器.

$ docker container ls -a
CONTAINER ID   IMAGE                        COMMAND                  CREATED              STATUS                          PORTS                     NAMES
7223f8b352bd   firedrakeproject/firedrake   "bash"                   About a minute ago   Exited (0) 4 seconds ago                                  angry_booth
27eedee6ef45   firedrakeproject/firedrake   "bash"                   About a minute ago   Exited (0) About a minute ago                             silly_hodgkin
ef05d20b0a6e   firedrakeproject/firedrake   "bash"                   3 minutes ago        Exited (0) 2 minutes ago                                  firedrake
b62a4a49ce89   lrtfm/firedrake-jupyter      "/bin/sh -c '/home/f…"   27 minutes ago       Up 27 minutes                   0.0.0.0:18888->8888/tcp   firedrake-jupyter

上一个命令中 -a 参数的作用是显示所有容器, 包括已经退出的容器, 否则只仅显示当前运行的容器.

由于镜像内的内容都是只读的, 你在运行它得到容器后, 可以对容器进行更改, 但对镜像本身是没有影响的. 由于容器是类似与进程的东西, 它也不是永久的, 所以我们在创建容器时一般会共享主机的文件夹给容器, 这样我们可以把程序和数据放在这个文件家中. 容器中对这个文件夹的修改在主机上是可见的, 也是可以永久留存的. 共享文件夹需要在运行 docker run 命令时, 使用 -v 选项:

docker run -v path-to-host-fold:path-to-container-fold firedrakeproject/firedrake

如果我像把当前目录共享给容器, 容器中路径设为 /home/firedrake/workdir, 就可以运行如下命令:

docker run -ti -v $(pwd):/home/firedrake/workdir  firedrakeproject/firedrake

运行后我们可以查看目录 /home/firedrake, 发现多了 workdir 目录, 其内容为主机文件夹中内容

$ docker run -ti -v $(pwd):/home/firedrake/workdir  firedrakeproject/firedrake
To run a command as administrator (user "root"), use "sudo <command>".
See "man sudo_root" for details.

firedrake@0895c511469e:~$ ls
firedrake  firedrake-install  firedrake-install.log  workdir
firedrake@0895c511469e:~$ ls
firedrake  firedrake-install  firedrake-install.log  workdir
firedrake@0895c511469e:~$ ls workdir/
Dockerfile.jupyter  Untitled.ipynb

1. -d 在后台运行容器

2. --name <the-name> 给容器命名, 这样下次可以直接使用 docker start <the-name> 启动容器, 而不用重新 docker run. 因为容器如果绑定主机端口的话, 不删除该容器 (即使该容器已退出), 就不能使用 docker run 绑定该端口. 我们使用 jupyter 时需要绑定端口, 使得我们可以使用主机的浏览器访问容器中的服务, 所以我们一般第一次使用 docker run --name <the-name> ... 创建一个有名字的容器, 下次直接使用 docker start <the-name> 即可运行, 如果要停止它秩序使用 docker stop <the-name> 即可.

3. -p <host-port>:<container-port> 端口映射, 把容器的端口 <container-port> 映射到主机的端口 <host-port>. 由于上述容器如 firedrakeproject/firedrake-notebooks 中的 jupyter 服务的端口为 8888, 这里就需要把 <container-port> 改为 8888, 而主机的端口可以任意设置, 只要没有使用过, 一般要大于 1024, 也可以设置为 8888