A list of todos for the next release of ensemble_md

[wehs7661]

Here we list the todos that should be done before the next release of the ensemble_md package. The release number has not been finalized and can be either 0.10.0 or 1.0.0 depending on the status of the paper review. Overall, the todos are to improve the code coverage and the documentation of the package. This issue includes updated components from the plans mentioned in issues #7, #26, and #33, as parts of them have become outdated.

Improving the code coverage

Note that we do not include adding unit tests for analysis/msm_analysis.py since MSM analysis for REXEE is a WIP.

• Add unit tests for analysis/analyze_free_energy.py
• Add unit tests for analysis/clustering.py
• Add unit tests for analysis/synthesize_data.py
• Complete test_mpi_func.py, which tests functions that use MPI
• Add unit tests for functionalities relevant to MT-REXEE, which are in replica_exchange_EE.py
• Re-examine the missed lines to push the code coverage as much as possible.
• Check if the warnings are actually harmless.

Potentially, we might want to consider adding regression tests for the CLIs.

Improving the documentation

• Update the theory section of the documentation
• Describe rules of thumb for REXEE parameters
• Proofread the entire documentation
• Proofread the docstrings
• Adding simple examples in some of the docstrings

Potentially, we might want to add some simple tutorials before the next release.

[wehs7661]

Closing the issue since all tasks listed here have been completed! Version 1.0.0 will be released upon the completion of PR #52 and the publication of the REXEE paper! 🤩