Skip to content

Commit

Permalink
docs improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
gbarter committed Feb 1, 2025
1 parent 3efeabc commit f4781ee
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 10 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pCrunch

IO and Post Processing for generic time series data of multibody aeroelastic wind turbine simulations. Readers are provided for OpenFAST outputs, but the analysis tools are equally applicable to HAWC2, Bladed, QBlade, ADAMS, or other tools.
IO and Post Processing for generic time series data of multibody aeroelastic wind turbine simulations. Readers are provided for OpenFAST outputs, but the analysis tools are equally applicable to HAWC2, Bladed, QBlade, ADAMS, or other tools. pCrunch attempts to capture the best of legacy tools MCrunch, MLife, and MExtremes, while also taking inspiration from other similar utilities available on Github.

## Installation as a Library

Expand Down Expand Up @@ -35,5 +35,21 @@ To set up pCrunch for development, follow these steps:

## Examples and Documentation

For an up to date example of the core functionalities, see the examples directory
For an up to date example of the core functionalities, see the examples-directory for Jupyter notebook examples, or the docs-directory for the same material.

There are two primary analysis classes in pCrunch:

1. The `AeroelasticOutputs` class
2. The `Crunch` class.

### The AeroelasticOutputs class

The `AeroelasticOutput` class is a general container for time-series based data for a single environmental condition (i.e., a single incoming wind spead and turbulence seed value). This might be a single run of your aeroelastic multibody simulation tool (OpenFAST or HAWC2 or Bladed or QBlade or in-house equivalents) in a larger parametric variation for design load case (DLC) analysis. The `AeroelasticOutput` class provides data containers and common or convenient manipulations of the data for engineering analysis.

### The Crunch class

The `Crunch` class is a general analysis tool for batches of time-series based data across multiple environmental conditions (i.e., a full wind speed and turbulence seed sweep). The methods are agnostic to the aeroelastic multibody simulation tool (OpenFAST or HAWC2 or Bladed or QBlade or in-house equivalents). The `AeroelasticOutput` class provides the data containers for each individual simulation. The `AeroelasticOutput` class provides many analysis capabilities and the `Crunch` class extends them into their batch versions.

The `Crunch` class supports keeping all time series data in memory and a lean "streaming" version where outputs are processed and then deleted, retaining only the critical statistics and analysis outputs.


4 changes: 2 additions & 2 deletions doc/aeroelastic_output_example.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# pCrunch's Aeroelastic Output class

The `AeroelasticOutput` class is a general container for time-series based data for a single environmental condition (i.e., a single incoming wind spead and turbulence seed value). This might be a single run of your aeroelastic multibody simulation tool (OpenFAST or HAWC2 or Bladed or QBlade or in-house equivalents) in a larger parametric variation for design load case (DLC) analysis. The `AeroelasticOutput` class provides data containers and common or convenient manipulations of the data for engineering analysis.
The `AeroelasticOutput` class is a general container for time-series based data for a single environmental condition (i.e., a single incoming wind spead and turbulence seed value). This might be a single run of your aeroelastic multibody simulation tool (OpenFAST or HAWC2 or Bladed or QBlade or in-house equivalents) in a larger parametric variation for design load case (DLC) analysis. The `AeroelasticOutput` class provides data containers and common or convenient manipulations of the data for engineering analysis.

Analysis that involve multiple time-series simulations, such as a full run of multiple wind speeds and seeds, which yield multiple AeroelasticOutput instances, is done in the *Crunch class*.
Analysis that involve multiple time-series simulations, such as a full run of multiple wind speeds and seeds, which yield multiple `AeroelasticOutput` instances, is done in the `Crunch` class.

This file lays out some workflows and showcases capabilities of the `AeroelasticOutput` class.

Expand Down
6 changes: 3 additions & 3 deletions doc/crunch_example.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# pCrunch's Crunch class

The Crunch class is a general analysis tool for batches of time-series based data across multiple environmental conditions (i.e., a full wind speed and turbulence seed sweep). The methods are agnostic to the aeroelastic multibody simulation tool (OpenFAST or HAWC2 or Bladed or QBlade or in-house equivalents). The AeroelasticOutput class provides the data containers for each individual simulation. The AeroelasticOutput class provides many analysis capabilities and the Crunch class extends them into their batch versions.
The `Crunch` class is a general analysis tool for batches of time-series based data across multiple environmental conditions (i.e., a full wind speed and turbulence seed sweep). The methods are agnostic to the aeroelastic multibody simulation tool (OpenFAST or HAWC2 or Bladed or QBlade or in-house equivalents). The `AeroelasticOutput` class provides the data containers for each individual simulation. The `AeroelasticOutput` class provides many analysis capabilities and the `Crunch` class extends them into their batch versions.

The Crunch class supports keeping all time series data in memory and a lean "streaming" version where outputs are processed and then deleted, retaining only the critical statistics and analysis outputs.
The `Crunch` class supports keeping all time series data in memory and a lean "streaming" version where outputs are processed and then deleted, retaining only the critical statistics and analysis outputs.

This file lays out some workflows and showcases capabilities of the Crunch class. It is probably best to walk through the examples of the AeroelasticOutput class first.
This file lays out some workflows and showcases capabilities of the `Crunch` class. It is probably best to walk through the examples of the `AeroelasticOutput` class first.

## Creating a new class instance

Expand Down
6 changes: 3 additions & 3 deletions examples/crunch_example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
"source": [
"# pCrunch's Crunch class\n",
"\n",
"The Crunch class is a general analysis tool for batches of time-series based data across multiple environmental conditions (i.e., a full wind speed and turbulence seed sweep). The methods are agnostic to the aeroelastic multibody simulation tool (OpenFAST or HAWC2 or Bladed or QBlade or in-house equivalents). The AeroelasticOutput class provides the data containers for each individual simulation. The AeroelasticOutput class provides many analysis capabilities and the Crunch class extends them into their batch versions.\n",
"The `Crunch` class is a general analysis tool for batches of time-series based data across multiple environmental conditions (i.e., a full wind speed and turbulence seed sweep). The methods are agnostic to the aeroelastic multibody simulation tool (OpenFAST or HAWC2 or Bladed or QBlade or in-house equivalents). The `AeroelasticOutput` class provides the data containers for each individual simulation. The `AeroelasticOutput` class provides many analysis capabilities and the `Crunch` class extends them into their batch versions.\n",
"\n",
"The Crunch class supports keeping all time series data in memory and a lean \"streaming\" version where outputs are processed and then deleted, retaining only the critical statistics and analysis outputs.\n",
"The `Crunch` class supports keeping all time series data in memory and a lean \"streaming\" version where outputs are processed and then deleted, retaining only the critical statistics and analysis outputs.\n",
"\n",
"This file lays out some workflows and showcases capabilities of the Crunch class. It is probably best to walk through the examples of the AeroelasticOutput class first."
"This file lays out some workflows and showcases capabilities of the `Crunch` class. It is probably best to walk through the examples of the `AeroelasticOutput` class first."
]
},
{
Expand Down

0 comments on commit f4781ee

Please sign in to comment.