From 209c76ff3ae91696001b550d67ea5fd6f5af6cb7 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Tue, 20 Jan 2026 09:56:57 +0000 Subject: [PATCH 1/4] introduce table within `README.md` for GitHub status badges --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d031bb6..d2377d5 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ [//]: # (Badges) -[![CodeEntropy CI](https://github.com/CCPBioSim/CodeEntropy/actions/workflows/project-ci.yaml/badge.svg)](https://github.com/CCPBioSim/CodeEntropy/actions/workflows/project-ci.yaml) -[![Docs - Status](https://app.readthedocs.org/projects/codeentropy/badge/?version=latest)](https://codeentropy.readthedocs.io/en/latest/?badge=latest) -![PyPI - Version](https://img.shields.io/pypi/v/codeentropy?logo=pypi&logoColor=white) -![PyPI - Status](https://img.shields.io/pypi/status/codeentropy?logo=pypi&logoColor=white) -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/CodeEntropy) -![PyPI - Total Downloads](https://img.shields.io/pepy/dt/codeentropy?logo=pypi&logoColor=white&color=blue) -![PyPI - Monthly Downloads](https://img.shields.io/pypi/dm/CodeEntropy?logo=pypi&logoColor=white&color=blue) -[![Coverage Status](https://coveralls.io/repos/github/CCPBioSim/CodeEntropy/badge.svg?branch=main)](https://coveralls.io/github/CCPBioSim/CodeEntropy?branch=main) +| Category | Badges | +|----------------|--------| +| **Build** | [![CodeEntropy CI](https://github.com/CCPBioSim/CodeEntropy/actions/workflows/project-ci.yaml/badge.svg)](https://github.com/CCPBioSim/CodeEntropy/actions/workflows/project-ci.yaml) | +| **Documentation** | [![Docs - Status](https://app.readthedocs.org/projects/codeentropy/badge/?version=latest)](https://codeentropy.readthedocs.io/en/latest/?badge=latest) | +| **PyPI** | ![PyPI - Status](https://img.shields.io/pypi/status/codeentropy?logo=pypi&logoColor=white) ![PyPI - Version](https://img.shields.io/pypi/v/codeentropy?logo=pypi&logoColor=white) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/CodeEntropy) ![PyPI - Total Downloads](https://img.shields.io/pepy/dt/codeentropy?logo=pypi&logoColor=white&color=blue) ![PyPI - Monthly Downloads](https://img.shields.io/pypi/dm/CodeEntropy?logo=pypi&logoColor=white&color=blue)| +| **Quality** | [![Coverage Status](https://coveralls.io/repos/github/CCPBioSim/CodeEntropy/badge.svg?branch=main)](https://coveralls.io/github/CCPBioSim/CodeEntropy?branch=main) | + CodeEntropy ============================== From ba95528cb9b3ae24aad5d9d715673afff5f41699 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Tue, 20 Jan 2026 09:57:49 +0000 Subject: [PATCH 2/4] remove copyright from `README.md` this is included in `LICENSE` --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index d2377d5..8f29577 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,6 @@ CodeEntropy is a Python package for computing the configurational entropy of mac See [CodeEntropy’s documentation](https://codeentropy.readthedocs.io/en/latest/) for more information. -## Copyright - -Copyright (c) 2025 CCPBioSim - - ## Acknowledgements Project based on From aac9ef09fe3aa44b818b1ace98a3fbbb8c652ce3 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Tue, 20 Jan 2026 09:59:33 +0000 Subject: [PATCH 3/4] fix heading in `README.md` --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 8f29577..8c81e97 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -[//]: # (Badges) | Category | Badges | |----------------|--------| | **Build** | [![CodeEntropy CI](https://github.com/CCPBioSim/CodeEntropy/actions/workflows/project-ci.yaml/badge.svg)](https://github.com/CCPBioSim/CodeEntropy/actions/workflows/project-ci.yaml) | From 9f5156a5a776dbf81e3e37b5409345ceef17ee54 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Tue, 20 Jan 2026 10:00:19 +0000 Subject: [PATCH 4/4] move GitHub badges table within `README.md` --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8c81e97..9f17eb2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +CodeEntropy +============================== + | Category | Badges | |----------------|--------| | **Build** | [![CodeEntropy CI](https://github.com/CCPBioSim/CodeEntropy/actions/workflows/project-ci.yaml/badge.svg)](https://github.com/CCPBioSim/CodeEntropy/actions/workflows/project-ci.yaml) | @@ -5,9 +8,6 @@ | **PyPI** | ![PyPI - Status](https://img.shields.io/pypi/status/codeentropy?logo=pypi&logoColor=white) ![PyPI - Version](https://img.shields.io/pypi/v/codeentropy?logo=pypi&logoColor=white) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/CodeEntropy) ![PyPI - Total Downloads](https://img.shields.io/pepy/dt/codeentropy?logo=pypi&logoColor=white&color=blue) ![PyPI - Monthly Downloads](https://img.shields.io/pypi/dm/CodeEntropy?logo=pypi&logoColor=white&color=blue)| | **Quality** | [![Coverage Status](https://coveralls.io/repos/github/CCPBioSim/CodeEntropy/badge.svg?branch=main)](https://coveralls.io/github/CCPBioSim/CodeEntropy?branch=main) | - -CodeEntropy -============================== CodeEntropy is a Python package for computing the configurational entropy of macromolecular systems using forces sampled from molecular dynamics (MD) simulations. It implements the multiscale cell correlation method to provide accurate and efficient entropy estimates, supporting a wide range of applications in molecular simulation and statistical mechanics.