mphowardlab / mphowardlab/azplugins

Add citations to `PeturbedLJ` documentation

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

Nobody has claimed this yet.

Dominant language
C++
Stars
27
Forks
18
Avg merge
1h 8m
Merged PRs (30d)
1

Description

This pair potential should document that it is the same functional form as Eqs. (3)–(6) of the classic Weeks–Chandler–Andersen paper.

It should also note that it is the same as the ashbaugh potential in azplugins prior to v1. Eq. (1) of Ashbaugh and Hatch is equivalent to the WCA perturbation theory, but folks working in the protein space may know this interaction under that name as a model for hydropathy.

Contributor guide

No contributing guide indexed for this repository

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

No documentation file or test is named in the issue. Locate the PeturbedLJ documentation, add the WCA and pre-v1 azplugins/ashbaugh citations and equivalence notes described in the issue, then verify that both references appear accurately in the rendered documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.