ep2lab/pyee repository overview

This is basically a FEniCS/dolfinx https://github.com/FEniCS/dolfinx⁠ image with some additional python dependencies needed to run the full FEM/FD PYEE suite.

⁠ADDITIONAL INSTRUCTIONS FOR CONTAINERS

⁠Building an image directly from DOLFINx https://hub.docker.com/u/dolfinx⁠

1. Install docker (sudo) https://docs.docker.com/engine/install/⁠, "DON'T forget Manage Docker as a non-root user"
2. We recommend to install the standard dolfinx image (follow the instructions at github)
3. Then start interactive container 'docker run -ti --rm --name pyee_cont ep2lab/pyee:local' (or the name of the image)
4. Inside the container use pip3 to install additional dependencies (scipy, yaml, h5py, matplotlib)
5. In another terminal OUTSIDE container get your user and group ids, 'id -u' and 'id -g', write down this numbers
6. INSIDE image run this (Recommended so created files have user permissions): addgroup --gid $GROUP_ID user adduser --disabled-password --gecos '' --uid $USER_ID --gid $GROUP_ID user
7. Now save the running container as a new image for example ep2lab/pyee:local docker commit pyee_cont ep2lab/pyee:local

⁠Now to RUN pyee:

⁠default mode:

docker run --rm -v $PYEE:/root -u $(id -u):$(id -g) --name pyee ep2lab/pyee:local /bin/bash pyee.sh example

⁠Or in hyphen mode:

docker run --rm -v $PYEE:/root -u $(id -u):$(id -g) --name pyee ep2lab/pyee:local /bin/bash pyee.sh HIP01_w hyphen

⁠Or solve pre-processed simulation:

docker run --rm -v $PYEE:/root -u $(id -u):$(id -g) --name pyee ep2lab/pyee:local /bin/bash pyee.sh HIP01_w solve_pre

⁠TIPS (cheatshet at docs/)

• List available images -> docker images ls
• List running/all containers -> docker ps' or 'docker ps- a
• Eliminate stopped containers -> docker container prune
• Run an interactive container and delete at exit -> docker run -ti --rm
• Mount file systems -> docker run -v origin:dest
• If there is some kind of error inside the wave code you might need to prune containers