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

Documentation clean up and update #712

Open
wants to merge 19 commits into
base: protos
Choose a base branch
from

Conversation

ChiCheng45
Copy link
Collaborator

@ChiCheng45 ChiCheng45 commented Mar 9, 2025

Description of work
Update to the documentation.

  • Remove some old rst files which were no longer used.
  • Removed unused images.
  • Changed Correlation Functions section to Time Series, it now includes a section on resolution function used in MDANSE.
  • Added Weight Scheme section which describes how the total are summed up from the partials.
  • Added q-Vector Generation section.
  • Updated all analysis job sections. In particular, all equations have been rewritten so that they follow the same notation throughout. Analysis job that are no longer available or are still in development have been marked.
  • Added Symbols and Notation section.
  • Removed a number of How-To Guide sections.
  • Removed Dynamic Coherent Structure Factor tutorial.

Feel free to make edits to this branch.

Fixes
Closes #411
Closes #375

@ChiCheng45 ChiCheng45 marked this pull request as ready for review March 9, 2025 18:47
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.

Update DOS documentation [BUG] When "weights" is used is the calculated result really a total?
1 participant