diff --git a/README.md b/README.md index c9bf545..1b1d411 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,30 @@ -# - QCManyBody ========== -[![GitHub Actitus](https://img.shields.io/github/actions/workflow/status/MolSSI/QCManyBody/ci.yml?logo=github)](https://github.com/MolSSI/QCManyBody/actions?query=workflow%3ACI) + +

+ + QCManyBody Logo + +

+ +[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/MolSSI/QCManyBody/ci.yml?logo=github)](https://github.com/MolSSI/QCManyBody/actions?query=workflow%3ACI) [![codecov](https://codecov.io/github/MolSSI/QCManyBody/graph/badge.svg?token=E4S0706HJ0)](https://codecov.io/github/MolSSI/QCManyBody) [![Documentation Status](https://img.shields.io/github/actions/workflow/status/MolSSI/QCManyBody/ci.yml?label=docs&logo=readthedocs&logoColor=white)](https://molssi.github.io/QCManyBody/) [![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/qcmanybody?color=blue&logo=anaconda&logoColor=white)](https://anaconda.org/conda-forge/qcmanybody) -[![Chat on Slack](https://img.shields.io/badge/chat-on_slack-808493.svg?longCache=true&style=flat&logo=slack)](https://join.slack.com/t/qcarchive/shared_invite/enQtNDIzNTQ2OTExODk0LTE3MWI0YzBjNzVhNzczNDM0ZTA5MmQ1ODcxYTc0YTA1ZDQ2MTk1NDhlMjhjMmQ0YWYwOGMzYzJkZTM2NDlmOGM) ![python](https://img.shields.io/badge/python-3.8+-blue.svg) -Many-Body Expansion (MBE) implementation with [QCSchema](https://github.com/MolSSI/QCSchema) and QCArchive integration. +QCManyBody is a python package for running quantum chemistry manybody expansions and interaction calculations in a +package-independent way. + +## Installation + +Currently, the package is only available on [GitHub](https://github.com/MolSSI/QCManyBody). To install directly +from GitHub, use the following command: + +```bash +pip install git+https://github.com/MolSSI/QCManyBody.git +``` + +## Documentation + +Full documentation is available at [https://molssi.github.io/QCManyBody/](https://molssi.github.io/QCManyBody/) \ No newline at end of file