https://github.com/klarh/flowws-freud
Reusable scientific workflows using freud
https://github.com/klarh/flowws-freud
analysis freud python workflows
Last synced: about 1 month ago
JSON representation
Reusable scientific workflows using freud
- Host: GitHub
- URL: https://github.com/klarh/flowws-freud
- Owner: klarh
- License: mit
- Created: 2020-01-29T20:08:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-04-27T19:57:38.000Z (about 3 years ago)
- Last Synced: 2025-04-20T15:17:08.773Z (about 2 months ago)
- Topics: analysis, freud, python, workflows
- Language: Python
- Size: 28.3 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
[](https://flowws-freud.readthedocs.io/en/latest/)
## Introduction
`flowws-freud` is an in-development set of modules to create reusable
pipelines for scientific simulations using
[freud](https://freud.readthedocs.io).
`flowws-freud` is being developed in conjunction with
[flowws](https://github.com/klarh/flowws) and
[flowws-analysis](https://github.com/klarh/flowws-analysis). See their
documentation for an overview of how to use the modules found here and
other useful modules for analysis and visualization of simulation
data, respectively.
## Installation
Install `flowws-freud` from PyPI:
```
pip install flowws-freud
```
Alternatively, install from source:
```
pip install git+https://github.com/klarh/flowws-freud.git#egg=flowws-freud
```
## Examples
Consult the
[flowws-examples](https://github.com/klarh/flowws-examples) project
for examples using `flowws-freud` modules.
## API Documentation
Browse more detailed documentation
[online](https://flowws-freud.readthedocs.io) or build the sphinx
documentation from source:
```
git clone https://github.com/klarh/flowws-freud
cd flowws-freud/doc
pip install -r requirements.txt
make html
```