https://github.com/klarh/garnets

Compatibility wrapper for glotzerlab garnett package
https://github.com/klarh/garnets

Last synced: 9 days ago
JSON representation

Compatibility wrapper for glotzerlab garnett package

• Host: GitHub
• URL: https://github.com/klarh/garnets
• Owner: klarh
• License: mit
• Created: 2020-03-12T19:20:05.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-21T21:42:07.000Z (almost 5 years ago)
• Last Synced: 2024-11-06T17:57:49.754Z (about 2 months ago)
• Language: Python
• Size: 4.88 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        

## Introduction

`garnets` is a very simple wrapper over the

[garnett](https://github.com/glotzerlab/garnett) package. In version

0.7, the API of garnett changed to rename some frame attributes

(positions, orientations, velocities) to their singular

form.

## Usage

`garnets` is mostly designed to be a drop-in replacement for the

garnett import at the top of your file:

```

import garnets as garnett

```

## Caveats

At the moment, only a basic compatibility layer is supported. Writing

trajectories using frame objects that fulfill only the old frame API

will not work, but writing frames that are read from a `garnets` or

`garnett` trajectory should work.