Add documentation for EnsembleMetrics

[vmullig]

This PR will add documentation for EnsembleMetrics, which are introduced in RosettaCommons/main#5824.

• RosettaCommons/main#5824 must be approved and ready to merge before this is merged.

• Add to sidebars.

• General description.

• Examples of usage:

  • As simple accumulator with report at end.
  • Using a ParsedProtocol for sampling, with immediate report.
  • Using a MultiplePoseMover, with immediate report.

• Note about MPI.

• Note about named metrics.

• Docs for CentralTendency ensemble metric.

  • Update auto-generated docs.
  • Note about interpretation of mode with floats.

• Docs for EnsembleFilter.

  • Update auto-generated docs.

TODO:

• Regenerate auto-generated docs following changes made to pull request RosettaCommons/main#5824 after review.

[jadolfbr]

Looks great Vikram! Very nice, extensive docs. Maybe when you merge, this could easily be a blog post.

[vmullig]

Maybe when you merge, this could easily be a blog post.

Sure!

[jadolfbr]

Hey Vikram,
Not sure if you still plan on merging this, but the review definitely slipped by me.

[vmullig]

Thanks, @jadolfbr. This will be merged eventually, but it will be publicly released under a free and open source licence first. I also want to incorporate it into other software projects, and I can't do that if RosettaCommons has an exclusive licence.