Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code Coverage, Precompiled OpenFAST Binaries, Docs Update #92

Merged
merged 5 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 28 additions & 10 deletions .github/workflows/CI.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:
push:
branches:
- master
tags: '*'
tags: ['*']
pull_request:
concurrency:
# Skip intermediate builds: always.
Expand All @@ -12,26 +12,44 @@ concurrency:
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
jobs:
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
name: Julia ${{ matrix.version }} - ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
version:
- '1.6'
- '1.10'
- '1'
os:
- ubuntu-latest
arch:
- x64
include:
- os: windows-latest
version: '1'
- os: macOS-latest
version: '1'
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: julia-actions/cache@v1
- uses: julia-actions/cache@v2
- name: Install OpenFASTWrappers
run: julia --project=./ -e 'using Pkg; Pkg.add([PackageSpec(url="https://github.com/byuflowlab/Composites.jl.git"),PackageSpec(url="https://github.com/sandialabs/OWENSPreComp.jl.git"),PackageSpec(url="https://github.com/sandialabs/OWENSOpenFASTWrappers.jl.git"),PackageSpec(url="https://github.com/sandialabs/OWENSAero.jl.git"),PackageSpec(url="https://github.com/sandialabs/OWENSFEA.jl.git")])'
shell: julia --color=yes --project=. {0}
run: |
using Pkg
Pkg.add([
PackageSpec(url="https://github.com/byuflowlab/Composites.jl.git"),
PackageSpec(url="https://github.com/sandialabs/OWENSOpenFAST_jll.jl.git"),
PackageSpec(url="https://github.com/sandialabs/OWENSOpenFASTWrappers.jl.git"),
PackageSpec(url="https://github.com/sandialabs/OWENSAero.jl.git"),
PackageSpec(url="https://github.com/sandialabs/OWENSFEA.jl.git"),
])
if: ${{ matrix.version == '1.10' }}
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-runtest@v1
- uses: julia-actions/julia-processcoverage@v1
- uses: codecov/codecov-action@v4
with:
file: lcov.info
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
9 changes: 5 additions & 4 deletions .github/workflows/Documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
push:
branches:
- master
tags: '*'
tags: ['*']
pull_request:

jobs:
Expand All @@ -13,14 +13,15 @@ jobs:
contents: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
with:
version: '1'
- uses: julia-actions/cache@v2
- name: Install dependencies
env:
PYTHON: ""
run: julia --project=docs/ -e 'using Pkg; Pkg.add(PackageSpec(url="https://github.com/byuflowlab/Composites.jl.git"));Pkg.add(PackageSpec(url="https://github.com/sandialabs/OWENSPreComp.jl.git"));Pkg.add(PackageSpec(url="https://github.com/sandialabs/OWENSOpenFASTWrappers.jl.git"));Pkg.add(PackageSpec(url="https://github.com/sandialabs/OWENSAero.jl.git")); Pkg.add(PackageSpec(url="https://github.com/sandialabs/OWENSFEA.jl.git")); Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
run: julia --project=docs/ -e 'using Pkg; Pkg.add(PackageSpec(url="https://github.com/byuflowlab/Composites.jl.git"));Pkg.add(PackageSpec(url="https://github.com/sandialabs/OWENSOpenFAST_jll.jl.git"));Pkg.add(PackageSpec(url="https://github.com/sandialabs/OWENSOpenFASTWrappers.jl.git"));Pkg.add(PackageSpec(url="https://github.com/sandialabs/OWENSAero.jl.git")); Pkg.add(PackageSpec(url="https://github.com/sandialabs/OWENSFEA.jl.git")); Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
Expand Down
12 changes: 12 additions & 0 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
MAT = "23992714-dd62-5051-b70f-ba57cb901cac"
OWENSAero = "ac8500f8-acb1-479a-8630-5dcb97b7c093"
OWENSFEA = "5906b1e7-6737-4278-91ec-d653c88addb4"
OWENSOpenFAST_jll = "ac0e1b5c-a850-5466-8291-e142bbb8e693"
OWENSOpenFASTWrappers = "1f4f357c-c864-4b71-8437-d48f9e1bb3e6"
OWENSPreComp = "7fd84261-8b17-47b6-a87d-1cc34e69440e"
OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
Expand All @@ -26,6 +27,13 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
WriteVTK = "64499a7a-5c06-52f2-abe2-ccb03c286192"
YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"

[sources]
Composites = {url = "https://github.com/byuflowlab/Composites.jl.git"}
OWENSAero = {url = "https://github.com/sandialabs/OWENSAero.jl"}
OWENSFEA = {url = "https://github.com/sandialabs/OWENSFEA.jl"}
OWENSOpenFAST_jll = {url = "https://github.com/sandialabs/OWENSOpenFAST_jll.jl"}
OWENSOpenFASTWrappers = {url = "https://github.com/sandialabs/OWENSOpenFASTWrappers.jl"}

[compat]
DelimitedFiles = "1"
Dierckx = "0.5"
Expand All @@ -34,6 +42,10 @@ FLOWMath = "0.3, 0.4"
GXBeam = "0.5.1"
HDF5 = "0.17"
MAT = "0.10"
OWENSAero = "1"
OWENSFEA = "1"
OWENSOpenFASTWrappers = "1"
OWENSOpenFAST_jll = "4"
OWENSPreComp = "1"
OrderedCollections = "1"
ProgressBars = "1"
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://sandialabs.github.io/OWENS.jl/dev)
![](https://github.com/sandialabs/OWENS.jl/workflows/CI/badge.svg)
[![codecov.io](https://codecov.io/github/sandialabs/OWENS.jl/coverage.svg?branch=master)](https://codecov.io/github/sandialabs/OWENS.jl?branch=master)

* *Documentation:* [sandialabs.github.io/OWENS.jl/](https://sandialabs.github.io/OWENS.jl/dev)
* *Code:* [github.com/sandialabs/OWENS.jl](https://github.com/sandialabs/OWENS.jl)
Expand All @@ -10,8 +11,17 @@ This package is for experienced researchers and analyists with both software and

OWENS is an ontology, or way of coupling modular aerodynamic, structural, hydrodynamic, and controls packages. It was originally based on the structural dynamics solver by Brian Owens (see dissertation: http://hdl.handle.net/1969.1/151813). However, it has been rewritten into the Julia programming language, modularized, and many of the issues related to aerodynamic coupling and floating dynamics solved, with extensive expansion into other areas and features to provide a seamless and automated process that takes in high level design details and does all of the preprocessing, running, and post processing that is normally done under different roofs or by different manual processes. This was done with the intent of enabling fast, parametric design. We have many of the modules propogating automatic gradients, however this is still a future challenge to solve well.

## Installation
For Julia 1.11+. For new Julia users, developer install, and those wishing to use Julia 1.10 and below, see the In-Depth Installation page in the docs.

```julia
using Pkg
Pkg.add(PackageSpec(url="https://github.com/sandialabs/OWENS.jl.git"))
```

<p><br></p>

Note that the following demo was recorded using the julia 1.10 installation method.

<p align="center"> <a href="https://www.youtube.com/watch?v=FTx9Jui_0CA?hd=1"> <img src="docs/src/assets/youtube_demo_image.png" alt="youtube.com/watch?v=FTx9Jui_0CA" style="width:70%"> </a> </p>

Expand Down
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ makedocs(;
modules = [OWENS],
pages = [
"Home" => "index.md",
"Installation" => "installation.md",
"Installation" => "indepth_installation.md",
"Examples" => [
joinpath("examples", "A_simplyRunningOWENS.md"),
joinpath("examples", "B_detailedInputs.md"),
Expand Down
Loading