glotzerlab / glotzerlab/coxeter
Add tests for form factor
Open
Nobody has claimed this yet.
good first issue
- Dominant language
- Python
- Stars
- 25
- Forks
- 5
- Avg merge
- 9m
- Merged PRs (30d)
- 3
Description
Feature description
It would be good to validate the form factor calculation much more thoroughly than the current implementation (either in the legacy ft.py module or in the new code in #92.
Proposed solution
There are many known form factors described here. We should use some of these as test cases.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the legacy ft.py module and the new form factor code referenced in issue #92, then review the linked form-factor equations. Add test cases covering several known form factors and verify that the implementation matches those equations in both relevant code paths where applicable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100