Skip to content

Python library to read in legacy HOOMD-blue XML files and current GSD files and convert to mbuild Compounds

License

Notifications You must be signed in to change notification settings

chrisiacovella/hoomdxml_reader

Repository files navigation

hoomdxml_reader

GitHub Actions Build Status codecov

A lightweight module to read legacy hoomdxml files and GSD files and convert to mbuild Compounds.

Provides basic routines to read and extract information included in hoomdxml files and GSD files, and provides routines to convert to 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.

Other relevant links:

Installation

Check out the source from the github repository:

$ git clone https://github.com/chrisiacovella/hoomdxml_reader.git

In the top level of hoomdxml_reader directory, use pip to install:

$ pip install -e .

The core functions of the module will require networkx to be installed. To create an environment named hoomdxml_reader with this necessary package, run the following from the top level of the hoomdxml_reader directory.

$ conda env create -f environment.yml

Optional packages

While not necessary to use the core functions of the Module, conversion to an mBuild Compound, requires mbuild to be installed.

$ conda install -c conda-forge mbuild

To visualize mbuild Compounds in Jupyter notebooks, install py3dmol:

$ conda install -c conda-forge py3dmol

git push origin HEAD:

Copyright

Copyright (c) 2022, Chris Iacovella

Acknowledgements

Project based on the Computational Molecular Science Python Cookiecutter version 1.1.

About

Python library to read in legacy HOOMD-blue XML files and current GSD files and convert to mbuild Compounds

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages