Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisiacovella authored Mar 22, 2023
1 parent 796d872 commit fc5d80e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@ hoomdxml_reader
[![codecov](https://codecov.io/gh/chrisiacovella/hoomdxml_reader/branch/main/graph/badge.svg)](https://codecov.io/gh/chrisiacovella/hoomdxml_reader/branch/main)


# A lightweight module to read legacy hoomdxml files.
Provides basic routines to read and extract information included in hoomdxml files. While there are other packages do support reading hoomdxml files, they do not parse all sections of the file. This code will also perform grouping of atoms into molecules based on connectivity. The module also provides routines to enable conversion to an mbuild ``Compound``.
# A lightweight module to read legacy hoomdxml files and GSD files.
Provides basic routines to read and extract information included in hoomdxml files and GSD files, and provides routines to convert to [mbuild](https://github.com/mosdef-hub/mbuild) ``Compounds``. While there are other packages do support reading hoomdxml files, they do not parse all sections of the file. This code will also perform grouping of atoms into molecules based on connectivity.

* [Documentation](https://hoomdxml-reader.readthedocs.io/en/latest/)

Other relevant links:

* [mBuild](https://github.com/mosdef-hub/mbuild)
* [HOOMD-blue](http://glotzerlab.engin.umich.edu/hoomd-blue/)
* [GSD](http://gsd.readthedocs.io)

## Installation

Expand Down

0 comments on commit fc5d80e

Please sign in to comment.