zt6659 / rigidori-animation

Tool to create rigid origami animation

Rigid Origami Animation Tool

The repository contains a package to create vtk files for rigid origami animation.

The current version supports:

• Single crease fold (a)
• Miura-ori (b)
• Single-orbit Hexagonal-triangular Resch (c)
• Triangular startuck (d)

List of packages

• ori-anim: Exports animation of selected rigid origami

Requirements

• Python 3.10.x
  • NumPy
  • Matplotlib
  • SciPy
  • tqdm
• ParaView 5.8 (Download from here. The latest version is 5.11, but runs slow on laptop and requires powerful machine)

Usage

Generate 3D geometry file

In root directory of the project, run the program with origami type specified (ori_type), e.g., for Miura-ori,

python -m ori-anime run --ori_type miura

or

python3 -m ori-anime run --ori_type miura

For single crease fold, Resch, and startuck, give "crease", "resch", and "startuck" respectively, instead of "miura".

Without other arguments, the program generates vtk files with default parameters. To define geometry, number of data points, and other options, see

python -m ori-anime run -h

or

python3 -m ori-anime run -h

Clean previous results

To clean all previous results (vtk_*/ directories and zip files) in the root directory, run

python -m ori-anime clean

or

python3 -m ori-anime clean

Setting up environment

Install Python

There are several different ways to install Python (for Mac and Linux, Python might be pre-installed and comes with OS).

1. Install with installer (Python official website)
2. Install with Python distribution (e.g., Anaconda)
3. Install with package manager (e.g., homebrew for Mac, apt for Debian/Ubuntu)
4. Install with version control tool (e.g., pyenv)

After installation, open terminal (e.g., PowerShell for Windows, Terminal for Mac and Linux) and run

python --version

or

python3 --version

Make sure that it returns Python 3.10.*.

Install required packages

To install packages, with pip

python -m pip install numpy matplotlib scipy tqdm PyQt5

or

python3 -m pip install numpy matplotlib scipy tqdm PyQt5

If the environmental path and alias are set for pip, simply

pip install numpy matplotlib scipy tqdm PyQt5

With Anaconda, either use GUI or

conda install numpy matplotlib scipy tqdm PyQt5

Author

• Yasuhiro Miyazawa (Dept. of Aero. & Astro., UW)
• Ted Chang (Dept. of Aero. & Astro., UW)