pCrunch
IO and Post Processing Interface for OpenFAST Results.
Authors: | Jake Nunemaker, Nikhar Abbas |
---|
Installation
pCrunch is installable through pip via pip install pCrunch
or conda, conda install pCrunch
.
Development Setup
To set up pCrunch for development, follow these steps:
-
Download the latest version of Miniconda for the appropriate OS. Follow the remaining steps for the appropriate OS version.
-
From the terminal, install pip by running:
conda install -c anaconda pip
-
Next, create a new environment for the project with the following.
conda create -n pcrunch-dev
To activate/deactivate the environment, use the following commands.
conda activate pcrunch-dev conda deactivate pcrunch-dev
-
Clone the repository:
git clone https://github.com/NREL/pCrunch.git
-
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]'
-
(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.