Skip to content

Commit

Permalink
Merge branch 'master' into 71-joss-paper
Browse files Browse the repository at this point in the history
  • Loading branch information
orbeckst authored Jul 18, 2024
2 parents 7a2b140 + f40b89b commit 2fca23e
Show file tree
Hide file tree
Showing 8 changed files with 66 additions and 118 deletions.
6 changes: 5 additions & 1 deletion CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,18 @@ The rules for this file:
* release numbers follow "Semantic Versioning" https://semver.org

------------------------------------------------------------------------------
??/??/2024 orbeckst

08/07/2024 orbeckst, xiki-tempula

* 2.3.1

Changes:
- alchemlyb adopts SPEC 0 (replaces NEP 29)
https://scientific-python.org/specs/spec-0000/

Fixes
- Support matplotlib 3.9.0 (issue alchemistry/flamel#28, PR#319).


21/05/2024 xiki-tempula

Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
include *.rst
recursive-include src/alchemlyb *.gz *.bz2 *.zip *.rst *.txt
include README.rst
include README.md
include LICENSE
include versioneer.py
include src/alchemlyb/_version.py
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# alchemlyb: the simple alchemistry library

[![Zenodo DOI](https://zenodo.org/badge/68669096.svg)](https://zenodo.org/badge/latestdoi/68669096) [![Documentation](https://readthedocs.org/projects/alchemlyb/badge/?version=latest)](http://alchemlyb.readthedocs.io/en/latest/) [![Build Status](https://github.com/alchemistry/alchemlyb/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/alchemistry/alchemlyb/actions/workflows/ci.yaml) [![Code coverage](https://codecov.io/gh/alchemistry/alchemlyb/branch/master/graph/badge.svg)](https://codecov.io/gh/alchemistry/alchemlyb) [![anaconda package](https://anaconda.org/conda-forge/alchemlyb/badges/version.svg)](https://anaconda.org/conda-forge/alchemlyb)

**alchemlyb** makes alchemical free energy calculations easier to do by leveraging the full power and flexibility of the PyData stack. It includes:

1. Parsers for extracting raw data from output files of common molecular dynamics engines such as [GROMACS](http://www.gromacs.org/), [AMBER](http://ambermd.org/), [NAMD](http://www.ks.uiuc.edu/Research/namd/) and [other simulation codes](https://alchemlyb.readthedocs.io/en/latest/parsing.html).

2. Subsamplers for obtaining uncorrelated samples from timeseries data (including extracting independent, equilibrated samples [Chodera2016](#chodera2016) as implemented in the [pymbar](http://pymbar.readthedocs.io/) package).

3. Estimators for obtaining free energies directly from this data, using best-practices approaches for multistate Bennett acceptance ratio (MBAR) [Shirts2008](#shirts2008) and BAR (from [pymbar](http://pymbar.readthedocs.io/)) and thermodynamic integration (TI).

## Installation

**Install** via `pip` from [PyPi (alchemlyb)](https://pypi.org/project/alchemlyb):

```bash
pip install alchemlyb
```

or as a `conda` package from the [conda-forge (alchemlyb)](https://anaconda.org/conda-forge/alchemlyb) channel:

```bash
conda install -c conda-forge alchemlyb
```

**Update** with `pip`:

```bash
pip install --update alchemlyb
```

or with `conda` run:

```bash
conda update -c conda-forge alchemlyb
```

to get the latest released version.

## Getting involved

Contributions of all kinds are very welcome.

If you have questions or want to discuss alchemlyb please post in the [alchemlyb Discussions](https://github.com/alchemistry/alchemlyb/discussions).

If you have bug reports or feature requests then please get in touch with us through the [Issue Tracker](https://github.com/alchemistry/alchemlyb/issues).

We also welcome code contributions: have a look at our [Developer Guide](https://github.com/alchemistry/alchemlyb/wiki/Developer-Guide). Open an issue with the proposed fix or change in the [Issue Tracker](https://github.com/alchemistry/alchemlyb/issues) and submit a pull request against the [alchemistry/alchemlyb](https://github.com/alchemistry/alchemlyb) GitHub repository.

## References

- <a name="shirts2008"></a> Shirts, M.R., and Chodera, J.D. (2008). Statistically optimal analysis of samples from multiple equilibrium states. The Journal of Chemical Physics 129, 124105.
- <a name="chodera2016"></a> Chodera, J.D. (2016). A Simple Method for Automated Equilibration Detection in Molecular Simulations. Journal of Chemical Theory and Computation 12, 1799–1805.
110 changes: 0 additions & 110 deletions README.rst

This file was deleted.

2 changes: 1 addition & 1 deletion devtools/conda-envs/test_env.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ dependencies:
- pymbar>=4
- scipy
- scikit-learn
- matplotlib
- matplotlib>=3.7
- loguru
- pyarrow

Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ dependencies:
- scipy
- scikit-learn
- pyarrow
- matplotlib
- matplotlib>=3.7
- loguru
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
packages=find_packages("src"),
package_dir={"": "src"},
license="BSD",
long_description=open("README.rst").read(),
long_description_content_type="text/x-rst",
long_description=open("README.md").read(),
long_description_content_type="text/markdown",
python_requires=">=3.9",
tests_require=["pytest", "alchemtest"],
install_requires=[
Expand All @@ -51,7 +51,7 @@
"pymbar>=4",
"scipy",
"scikit-learn",
"matplotlib",
"matplotlib>=3.7",
"loguru",
"pyarrow",
],
Expand Down
2 changes: 1 addition & 1 deletion src/alchemlyb/visualisation/ti_dhdl.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,6 @@ def getInd(r=ri, z=[0]):
color="#151B54",
)
lege = ax.legend(prop=FP(size=14), frameon=False, loc=1)
for l in lege.legendHandles:
for l in lege.legend_handles:
l.set_linewidth(10)
return ax

0 comments on commit 2fca23e

Please sign in to comment.