Skip to main content

IO and Post Processing Interface for OpenFAST Results.

Project description

IO and Post Processing Interface for OpenFAST Results.

Version:

0.2.0

Authors:

Jake Nunemaker, Nikhar Abbas

Installation

pCrunch is installable through pip via pip install pCrunch.

Development Setup

To set up pCrunch for development, follow these steps:

  1. Download the latest version of Miniconda for the appropriate OS. Follow the remaining steps for the appropriate OS version.

  2. From the terminal, install pip by running: conda install -c anaconda pip

  3. Next, create a new environment for the project with the following.

    conda create -n pcrunch-dev python=3.7

    To activate/deactivate the environment, use the following commands.

    conda activate pcrunch-dev
    conda deactivate pcrunch-dev
  4. Clone the repository: git clone https://github.com/NREL/pCrunch.git

  5. Navigate to the top level of the repository (<path-to-pCrunch>/pCrunch/) and install pCrunch as an editable package with following commands.

    pip install -e '.[dev]'
  6. (Preferred) Install the pre-commit hooks to autoformat code, ensuring consistent code style across the repository.

    pre-commit install

Examples

For an up to date example of the core functionalities, see example.ipynb. More examples coming soon.

Other Scripts

Warning: These scripts have not been updated since the move to version 0.2.0.

There are also several utility scripts provided in this repo. The HPC_tools folder contains utility functions for working on the NREL HPC. postProcessing contains a script for analyzing the results of multiple runs.

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

pCrunch-1.0.1.tar.gz (5.9 MB view hashes)

Uploaded Source

Built Distribution

pCrunch-1.0.1-py3-none-any.whl (6.0 MB 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