Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bennybp committed Apr 22, 2024
1 parent 0b3f183 commit 60212b3
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,30 @@
# <img src="https://github.com/MolSSI/QCManyBody/blob/main/docs/logo.png" height=150>

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)

<p align="center">
<picture>
<img alt="QCManyBody Logo" src="https://github.com/MolSSI/QCManyBody/blob/main/docs/logo.png" height="150px">
</picture>
</p>

[![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/)

0 comments on commit 60212b3

Please sign in to comment.