pyiron / pyiron/atomistics

Output labels -- consistent nomenclature

Open
#129 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
10
Forks
4
Avg merge
12h 31m
Merged PRs (30d)
13

Description

In https://github.com/pyiron/atomistics/pull/123 the LAMMPS output for calc_static() defines the output energy as energy. This equals the potential energy calculated by calc_md(). We should address this inconsistency and make sure it is still consistent with the other simulation code interfaces.

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

Start by reviewing pull request 123 and the implementations of calc_static() and calc_md() that produce the LAMMPS outputs. Compare their energy labels with the other simulation code interfaces. Done means the nomenclature is consistent across these interfaces and the affected behavior is covered by the relevant tests.

Written by the indexing model from the issue text.

Assessment

Domain
hpc
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.