docs: working with individual results page #783
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #783 +/- ##
==========================================
- Coverage 94.12% 92.31% -1.82%
==========================================
Files 133 133
Lines 9767 9767
==========================================
- Hits 9193 9016 -177
- Misses 574 751 +177
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
@richardjgowers : Are you also planning on talking about the additional metrics we're getting, like the overlap matrix, forward-backward analysis or the replica exchange plots? I started explaining some of that in the |
|
@hannahbaumann not on this page/PR, but if you leave it as a todo on your PR I'll fill in the details for HREX |
richardjgowers
changed the title
reorder to mention command line results first as this is the easier route to follow
richardjgowers
force-pushed
the
issue_745_results_docs
branch
from
dda3318 to
b98cfb4
Compare
add reference to working with results networks docs
docs/guide/results/index.rst
Outdated
| this class takes care of the averaging and concatenation of different iterations of the estimation process. | ||
| This ``ProtocolResult`` class has ``.get_estimate()`` and ``.get_uncertainty()`` methods which return the estimates | ||
| of free energy difference along with its uncertainty. | ||
|
|
There was a problem hiding this comment.
Outside of the showcase tutorial is the code of this demonstrated anywhere? Otherwise we should raise an issue to at least have a minimum code example demonstrating it?
Co-authored-by: Irfan Alibay <[email protected]>
Co-authored-by: Irfan Alibay <[email protected]>
rename current working with results page to inside new toctree
richardjgowers
changed the title
addresses #745