Skip to content

Version 1.0 Documentation #43

Description

@skfegan

Rewrite all the documentation to account for the code refactor.

This needs to be done before the next release, but should wait until most of the code changes are complete so that it accurately reflects the new code structure.

Issue #8 Amber inputs is one item that should go in the documentation.

Activity

  1. self-assigned this
    on Mar 4, 2025
  2. added this to the milestone on Mar 21, 2025
  3. skfegan commented on Mar 27, 2025

    @skfegan
    MemberAuthor

    Document the choice of bin_width = 30. Argo's protein paper SI should have a good explanation.

  4. skfegan commented on Mar 27, 2025

    @skfegan
    MemberAuthor

    Document force_partitioning. Why is it used? When is it used? Why is the default value 0.5?

  5. skfegan commented on Apr 7, 2025

    @skfegan
    MemberAuthor

    Add to the documentation information about getting forces in the same trajectory file as the positions.

    Also, comment on the amount of sampling needed to get reasonable results. Research question to determine how many frames you need. I expect it is proportional to the number of residues in the system. If the sampling is too small you get negative eigenvalues in the vibrational entropy calculation.

  6. modified the milestones: , 1.0.0 release on Jun 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions