Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Single Chain system class #192

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

StephMcCallum
Copy link
Contributor

@StephMcCallum StephMcCallum commented Feb 28, 2025

  • doc strings
  • add to library/systems.py
  • make it work for AA atom models and atom indices (different ways to get length of polymer or mbuild compound, spicy.pdist)
  • unit tests

@chrisjonesBSU chrisjonesBSU linked an issue Feb 28, 2025 that may be closed by this pull request
@chrisjonesBSU chrisjonesBSU self-requested a review February 28, 2025 20:22
Copy link
Member

@chrisjonesBSU chrisjonesBSU left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good start! I left a few comments for changes.

Copy link

codecov bot commented Feb 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.90%. Comparing base (a600b73) to head (e68e4a9).
Report is 58 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #192      +/-   ##
==========================================
+ Coverage   94.77%   94.90%   +0.13%     
==========================================
  Files          26       26              
  Lines        1970     2023      +53     
==========================================
+ Hits         1867     1920      +53     
  Misses        103      103              

Copy link
Member

@chrisjonesBSU chrisjonesBSU left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple more comments. We just need some unit tests now.

class SingleChainSystem(System):
"""Builds a box around a single chain.

Calculates the maximum distance of the chain using scipy.spatial.distance.pdist().
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can expand here a little. We should say that the box lengths are chosen so that they are at least as long as the largest particle part distance. We could say that the chain is centered in the volume.


Parameters
----------
See System class.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a doc string for the buffer parameter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a SingleChain system class.
2 participants