Skip to main content

Stage-based scientific workflows using freud

Project description

ReadTheDocs

Introduction

flowws-freud is an in-development set of modules to create reusable pipelines for scientific simulations using freud.

flowws-freud is being developed in conjunction with flowws and 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 project for examples using flowws-freud modules.

API Documentation

Browse more detailed documentation online 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flowws-freud-0.3.0.tar.gz (4.6 kB view hashes)

Uploaded Source

Built Distribution

flowws_freud-0.3.0-py3-none-any.whl (7.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page