WuKong Codebase

Depending on what you need you may choose to build the specific project by changing the CMakeLists.txt in the Project folder

Ideally basic simulation models such as, -DiscreteShell, FEM2D/3D, EoLRods- should have only the basic implementation such that they can be inherited whenever needed.

Instructions for Windows

Install WSL2 from Powershell or Command Prompt:

$ wsl --install

From the WSL terminal, clone the repository:

$ git clone https://github.com/liyuesolo/Wukong2024 --recurse-submodules

Navigate to the repository folder:

$ cd Wukong2024

Open in VSCode:

$ code .

Rename .devcontiner/devcontainer_windows.json to .devcontainer/devcontainer.json, replacing the existing one. Follow the instructions for Run Docker in VSCode.

Give WSL access to the internet for building the docker image. Run the following to open a file editor and replace the existing IP address with 8.8.8.8

$ sudo nano /etc/resolv.conf

Docker

Download the docker image. Change tag "linux" if needed.

$ docker pull wukongsim/wukong:linux

If you wish to build the docker image from scratch from the Dockerfile (not recommended) or rebuild after modifying the dockerfile, run the following in the command line from the directory Wukong2024/.devcontainer.

$ docker build -t wukongsim/wukong:linux .

If finished modifying the Dockerfile, push to dockerhub.

$ docker push wukongsim/wukong:linux

Install NVIDIA Docker

$ curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg

$ curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list |
sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' |
sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list

$ sudo sed -i -e '/experimental/ s/^#//g' /etc/apt/sources.list.d/nvidia-container-toolkit.list

$ sudo apt-get update

$ sudo apt-get install -y nvidia-container-toolkit

$ sudo nvidia-ctk cdi generate --output=/etc/cdi/nvidia.yaml

$ sudo nvidia-ctk runtime configure --runtime=docker

$ sudo systemctl restart docker

Enable Display

Enable Docker to connect to host display to spawn GUI windows. Run from command line on host machine, repeat in case of display error.

$ xhost +

Run Docker in VSCode

Open the repository folder in VSCode. Install Docker and Dev Containers extensions in VSCode.

In VSCode, type control + p, then type >Reopen in Container (with the '>'). This option will show up in the >< tab in the bottom left corner of vscode.

The above command will open a dev container using the docker image we provided.

There you go!

Run Docker from Command Line

Navigate to repository home directory.

$ cd Wukong2024

Open the Docker container.
-v ./:/{directory-name-in-container} maps current working directory (.) to /{directory-name-in-container} in the Docker container.
--network=host -e DISPLAY=$DISPLAY --privileged enables use of host display to spawn GUI windows.

$ docker run -v ./:/{directory-name-in-container} -it --network=host -e DISPLAY=$DISPLAY --privileged --rm wukongsim/wukong:linux bash

Build the code.

$ cd {directory-name-in-container}

$ ./build.sh

Docker Image Building Time

Building this docker image can take a while, for downloading MKL libraries and compiling SuiteSparse from the source code (just to remove a single print). In case you have a powerful workstation, considering changing all the make -j8 to make -j128.

Projects Tested Compiling

Discrete Shell [x] Linux [] MacOs
FEM3D [x] Linux [] MacOs
EoLRods [x] Linux [] MacOs
Isohedral Tiling [x] Linux [] MacOs

Coding Convention

Naming Convention

NAMESPACE_EXAMPLE
ClassExample
functionExample
variable_example
TypenameExample

To-Dos

dynamics simulation (see Discrete Shell)
Set up application base class
Use curvature binormal for compute dihedral angles
FEM2D
IPC contact examples

More Info

If WuKong contributes to an academic publication, cite it as:

@misc{wukong,
  title = {WuKong},
  author = {Yue Li and others},
  note = {https://github.com/liyuesolo/Wukong2024},
  year = {2024}
}

liyuesolo / Wukong2024