Skip to content

Orientation Estimation Doc Page#1364

Merged
j-c-c merged 15 commits into
developfrom
cl_docs
Apr 24, 2026
Merged

Orientation Estimation Doc Page#1364
j-c-c merged 15 commits into
developfrom
cl_docs

Conversation

@j-c-c
Copy link
Copy Markdown
Collaborator

@j-c-c j-c-c commented Feb 16, 2026

Adds a doc page for a high-level overview of the CL methods

@j-c-c j-c-c self-assigned this Feb 16, 2026
@j-c-c j-c-c added the documentation Improvements or additions to documentation label Feb 16, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 16, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.20%. Comparing base (2e8a593) to head (6ec4ddb).
⚠️ Report is 15 commits behind head on develop.

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop    #1364   +/-   ##
========================================
  Coverage    90.20%   90.20%           
========================================
  Files          135      135           
  Lines        14658    14658           
========================================
  Hits         13222    13222           
  Misses        1436     1436

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@j-c-c j-c-c changed the title [WIP] Orientation Estimation Doc Page Orientation Estimation Doc Page Mar 4, 2026
@j-c-c j-c-c requested a review from garrettwrong March 4, 2026 20:08
garrettwrong
garrettwrong requested changes Mar 12, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@garrettwrong garrettwrong left a comment

Choose a reason for hiding this comment

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

Thanks! Overall this is great. Couple minor changes, and a couple questions.

There is one lingering question we can discuss in the meeting, and that is how detailed the docs should be.

Comment thread docs/source/orientation_estimation.rst Outdated
Comment thread docs/source/orientation_estimation.rst Outdated
Comment thread docs/source/orientation_estimation.rst
Comment thread docs/source/orientation_estimation.rst
Comment thread docs/source/orientation_estimation.rst Outdated
Comment thread docs/source/orientation_estimation.rst
Comment thread docs/source/orientation_estimation.rst
Comment thread docs/source/orientation_estimation.rst Outdated
Comment thread docs/source/orientation_estimation.rst Outdated
Comment thread docs/source/orientation_estimation.rst Outdated
@j-c-c j-c-c changed the base branch from Jsync_gpu to develop March 19, 2026 13:42
@j-c-c j-c-c requested a review from garrettwrong March 19, 2026 13:43
@j-c-c
Copy link
Copy Markdown
Collaborator Author

j-c-c commented Mar 19, 2026

@garrettwrong thanks for the review. I hit all your points and fixed the base branch to develop, so this should be good for you to look at again. Thanks!

garrettwrong
garrettwrong previously approved these changes Mar 19, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@garrettwrong garrettwrong left a comment

Choose a reason for hiding this comment

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

Thanks. It will be nice to get this addition to the docs, thanks.

@j-c-c j-c-c marked this pull request as ready for review March 20, 2026 14:21
@j-c-c j-c-c requested a review from janden as a code owner March 20, 2026 14:21
janden
janden previously approved these changes Apr 23, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@janden janden left a comment

Choose a reason for hiding this comment

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

Looks great! Just one small thing.

Comment thread docs/source/orientation_estimation.rst Outdated
Algorithms for Asymmetric Molecules
-----------------------------------

ASPIRE offers several orientation estimation algorithms for handling molecules with asymmetric data:
Copy link
Copy Markdown
Collaborator

@janden janden Apr 23, 2026

Choose a reason for hiding this comment

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

asymmetric molecules

Copy link
Copy Markdown
Collaborator Author

@j-c-c j-c-c Apr 23, 2026

Choose a reason for hiding this comment

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

sure. done.

@j-c-c j-c-c dismissed stale reviews from janden and garrettwrong via 5168887 April 23, 2026 17:38
@j-c-c j-c-c merged commit 8366965 into develop Apr 24, 2026
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@garrettwrong garrettwrong garrettwrong approved these changes

@janden janden janden left review comments

Assignees

@j-c-c j-c-c

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@j-c-c @janden @garrettwrong