matflow.environments.env_configure_damask#

matflow.environments.env_configure_damask(shell, setup=None, docker_image=None, docker_archive=None, singularity_archive=None, singularity_sif=None, docker_exe='docker', singularity_exe='singularity')#

Configure the MatFlow DAMASK environment.

If passing a path to an archive, the name of the image within the archive can be passed via docker_image.

Parameters:

  • docker_image (str | None) – Name of the docker image to use.

  • docker_archive (str | Path | None) – File path to an archived docker tar file. Use docker_image to set the image name within the tar (assumed to be “damask”).

  • singularity_archive (str | Path | None) – File path to an archived docker tar file to be converted into a singularity sif file to use.

  • singularity_sif (str | Path | None) – File path to a Singularity sif file to use.

  • shell (Literal['bash', 'powershell']) –

  • setup (str | list[str] | None) –

  • docker_exe (str) –

  • singularity_exe (str) –