Skip to content

Prepare documentation for publication #40

Merged
yaoyic merged 7 commits intomainfrom
bugfix/docs_build
Jan 31, 2025
Merged

Prepare documentation for publication #40
yaoyic merged 7 commits intomainfrom
bugfix/docs_build

Conversation

@sayeg84
Copy link
Collaborator

@sayeg84 sayeg84 commented Jan 30, 2025

PR Checklist

  • [] Bug fix
  • [] Feature addition/change
  • Documentation addition/change
  • [] Test addition/change
  • [] Black formatting

Describe your changes here:

I made a small fixes for the docs:

  1. Updated the documentation.yaml file parsed by github access so that the requirements of the package are installed when building the docs and then the documentation is correctly build
  2. Added
  3. Reformated the docs of the Ensemble class.

Copy link
Collaborator

@yaoyic yaoyic left a comment

Choose a reason for hiding this comment

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

Looks good to me. Two small questions are in the comments
p.s. the CI tests and linter seem to be broken. Should we fix it?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we need multiple pdb files if the topology is the same?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Probably not but it makes it easier for loading the trajectories, and also for loading them into a visualizer like pymol.

and `coords` (and unitcell + simulation times, if available) into a dictionary of
`mdtraj.Trajectory` for analyses according to `self.trjs`
- `.get_all_in_one_mdtraj_trj()`: pack all `coords` into one `Trajectory` object
(maybe not suitable for kinetic analyses, such as TICA and MSM!)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we just delete all these text or can we put them to somewhere else?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If got moved to docs/source/ensemble.rst

@yaoyic yaoyic merged commit e38917c into main Jan 31, 2025
0 of 2 checks passed
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.

2 participants