Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ljwoods2 committed Nov 29, 2024
1 parent 959ceb5 commit f67efaa
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,17 @@ IMDClient
[url_license]: https://opensource.org/license/mit
[url_mda]: https://www.mdanalysis.org

Receiver for IMDv3 protocol from simulation engines like Gromacs, LAMMPS, and NAMD.
Receiver for [IMDv3 protocol](https://imdclient.readthedocs.io/en/latest/protocol_v3.html) from simulation engines like Gromacs, LAMMPS, and NAMD.

IMDClient is bound by a [Code of Conduct](https://github.com/becksteinlab/imdreader/blob/main/CODE_OF_CONDUCT.md).

### Installation

IMDClient is available via PyPi and can be installed with pip:
```bash
pip install imdclient
```

To build IMDClient from source,
we highly recommend using virtual environments.
If possible, we strongly recommend that you use
Expand Down

0 comments on commit f67efaa

Please sign in to comment.