Skip to content

New function mdtools.dtrj.trans_rate_tot to calculate the transition rates#211

Merged
andthum merged 3 commits intomainfrom
feat/src/mdtools/dtrj/trans-rate-tot
Dec 20, 2023
Merged

New function mdtools.dtrj.trans_rate_tot to calculate the transition rates#211
andthum merged 3 commits intomainfrom
feat/src/mdtools/dtrj/trans-rate-tot

Conversation

@andthum
Copy link
Owner

@andthum andthum commented Dec 20, 2023

New function mdtools.dtrj.trans_rate_tot to calculate the transition rates

Type of change

  • Change of core package.
  • Change of scripts.
  • Bug fix.
  • New feature.
  • Code refactoring.
  • Dependency update.
  • Documentation update.
  • Maintenance.
  • Other: Description.
  • Non-breaking (backward-compatible) change.
  • Breaking (non-backward-compatible) change.

Proposed changes

Create a new function mdtools.dtrj.transition that calculates the transition rate averaged over all compounds and over all states.

PR checklist

  • I followed the guidelines in the Developer's guide.
  • New/changed code is properly tested.
  • New/changed code is properly documented.
  • The CI workflow is passing.

Create a new function `mdtools.dtrj.transition` that calculates the
transition rate averaged over all compounds and over all states.
Refactor the function `mdtools.dtrj.trans_rate_tot`:

* Add new argument `axis` that allows the user to specify the axis along
  which to search for state transitions.
* If the argument `discard_all_neg` is `True`, calculate the total
  number of valued frames using the function `mdtools.dtrj.lifetimes`.
* Add examples to the docstring.
@github-actions github-actions bot added enhancement New feature or request minor Change that results in a new minor version labels Dec 20, 2023
@andthum andthum merged commit b5ead3f into main Dec 20, 2023
@andthum andthum deleted the feat/src/mdtools/dtrj/trans-rate-tot branch December 20, 2023 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request minor Change that results in a new minor version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant