SolvationAnalysis
==============================
[//]: # (Badges)

[![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://www.numfocus.org/)
[![Powered by MDAnalysis](https://img.shields.io/badge/powered%20by-MDAnalysis-orange.svg?logoWidth=16&logo=data:image/x-icon;base64, )](https://www.mdanalysis.org)
[![GitHub Actions Status](https://github.com/MDAnalysis/solvation-analysis/workflows/CI/badge.svg)](https://github.com/MDAnalysis/solvation-analysis/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/MDAnalysis/solvation-analysis//branch/main/graph/badge.svg)](https://codecov.io/gh/MDAnalysis/solvation-analysis//branch/main)
[![docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://solvation-analysis.readthedocs.io/en/latest/)
[![DOI](https://zenodo.org/badge/371804402.svg)](https://zenodo.org/badge/latestdoi/371804402)


---

Solvation analysis implements a robust, cohesive, and fast set of methods
for analyzing the solvation structure of a liquid. It seamlessly integrates with
[MDAnalysis](https://www.mdanalysis.org/), making use of the core AtomGroup
and Universe data structures to parse solvation information. If you are interested
in understanding the solvation structure of a liquid, this package is for you!


Find documentation and tutorials on [readthedocs].

### Installing SolvationAnalysis

SolvationAnalysis is available on PyPI and can be installed with pip:

```bash
pip install solvation-analysis
```

### Contributing

Contributions, both issues and PRs, are welcome. If you'd like to contribute, we ask that you 
follow the community guidelines outlined in the [MDAnalysis Code of Conduct](https://www.mdanalysis.org/pages/conduct/).

---

#### Acknowledgements

Google Summer of Code and the MDAnalysis team provided funding and support for this project.

Main development by @orioncohen, with mentorship from @richardjgowers, @IAlibay, 
@hmacdope, and @htz1992213.

Project based on the 
[Computational Molecular Science Python Cookiecutter](https://github.com/molssi/cookiecutter-cms) version 1.5.



[readthedocs]: (https://solvation-analysis.readthedocs.io/en/latest/)
[robust, cohesive, and fast set of methods]:(https://summerofcode.withgoogle.com/projects/#6227159028334592)
[Google Summer of Code]: https://summerofcode.withgoogle.com/
[MDAnalysis]: https://www.mdanalysis.org/
