Skip to main content

Stage-based scientific workflows for system analysis

Project description

ReadTheDocs

Introduction

flowws-analysis is an in-development set of flowws modules to create reusable analysis pipelines for scientific simulations. Although it is currently mostly useful for analyzing structures found in molecular simulation (together with flowws-freud), the framework can be used as a base for analysis and visualization in jupyter notebooks or a standalone GUI for other application domains.

Installation

Install flowws-analysis from PyPI (note that most modules require dependencies; use the second pip install command below to install those) :

# this installs flowws-analysis without any prerequisites
pip install flowws-analysis

# optional prerequisites can be installed via extras, for example:
pip install flowws-analysis[garnett,gtar,notebook,plato,pyriodic,qt]

Alternatively, install from source:

pip install git+https://github.com/klarh/flowws-analysis.git#egg=flowws-analysis

Examples

Consult the flowws-examples project for examples using flowws-analysis modules.

API Documentation

Browse more detailed documentation online or build the sphinx documentation from source:

git clone https://github.com/klarh/flowws-analysis
cd flowws-analysis/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.

Files for flowws-analysis, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size flowws_analysis-0.7.0-py3-none-any.whl (27.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size flowws-analysis-0.7.0.tar.gz (21.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page