glotzerlab / glotzerlab/hoomd-examples

Tutorial: Rigid bodies in HPMC

Open
#142 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Jupyter Notebook
Stars
40
Forks
14
Avg merge
16h 29m
Merged PRs (30d)
3

Description

Tutorial description

Demonstrate the two ways (Union integrators and Union pair potentials) to create rigid bodies in HPMC.

Section

Add these sections to the "Modelling Rigid Bodies" tutorial.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the existing "Modelling Rigid Bodies" tutorial and review its current structure before adding the requested sections. Document both approaches to creating rigid bodies in HPMC—Union integrators and Union pair potentials; the work is done when the tutorial demonstrates both methods.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.