Skip to content

Commit

Permalink
Merge pull request #19 from IEAWindTask37/release-1.0.0
Browse files Browse the repository at this point in the history
Release 1.0.0
  • Loading branch information
akey7 authored Dec 18, 2020
2 parents 9a4f167 + ec59b5e commit fda626e
Show file tree
Hide file tree
Showing 10 changed files with 1,747 additions and 2,377 deletions.
38 changes: 35 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,39 @@
# windio2cad

Example command line:
## What is `windio2cad`?

The `windio2cad` module is a command line tool to convert `.yaml` files that follow the [windio ontology](https://windio.readthedocs.io/en/latest/) into `.stl` CAD files. These CAD files can then be used as input to other codes or for visualization.

Two example files for floating offshore wind turbine (FOWT) platforms are included in this source repository:

- `nrel5mw-spar_oc4.yaml`: A semisubmersible floating platform.

- `nrel5mw-spar_oc3.yaml`: A spar-type floating platform.

Read below to learn more about rendering these `.yaml` files into `.stl` files.

## Installation

This instllation guide assumes you are using `conda` for management of virtual environments. Clone the repository and change into the repository's directory:

```
python semisubmersible_yaml_to_stl.py --input semisubmersible.yaml --output semisubmersible2.stl --modules modules_for_rendering_semisubmersible.scad --openscad "/Applications/OpenSCAD.app/Contents/MacOS/OpenSCAD"
```
conda create -n windio2cad python=3.8
conda activate windio2cad
pip install -e .
```

This module depends on the OpenSCAD package to be installed to render the final `.stl` file. See [http://www.openscad.org/](http://www.openscad.org/)

## Usage

Use the following command to create an `.stl` file for a turbine atop a semisubmersible foundation:

```
python -m windio2cad --input nrel5mw-semi_oc4.yaml --output turbine.stl --openscad [PATH TO OPENSCAD]
```

Replace `[PATH TO OPENSCAD]` with the path to OpenSCAD on your operating system.

### Rendering just the blade

In some applications, only a rendering of the blade is needed. In those cases, simply add the `--blade` option to the command line to render just the blade.
949 changes: 0 additions & 949 deletions blade/IEA-15-240-RWT.yaml

This file was deleted.

615 changes: 0 additions & 615 deletions blade/IEA-15-240-RWT_FineGrid.yaml

This file was deleted.

304 changes: 0 additions & 304 deletions blade/lofted_extrusions.py

This file was deleted.

Loading

0 comments on commit fda626e

Please sign in to comment.