mooring

Design and analysis of oceanographic moorings

https://github.com/dankelley/mooring

Keywords

Repository

Design and analysis of oceanographic moorings

README.Rmd

---
output: github_document
bibliography: vignettes/mooring.bib
---



```{r, include = FALSE}
knitr::opts_chunk$set(
    collapse = TRUE,
    comment = "#>",
    fig.path = "man/figures/README-",
    out.width = "100%"
)
```

# mooring


[![R-CMD-check](https://github.com/dankelley/mooring/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dankelley/mooring/actions/workflows/R-CMD-check.yaml)





The goal of the `mooring` package is to facilitate computations in the
R language of the deformation of oceanographic moorings by ocean
currents. It builds on Fortran code discussed by
@moller_computer_1976, which evolved into a new form as discussed by
@hamilton_mooring_1997 and @hamilton_validation_1989, and then a
Matlab form discussed by @dewey_mooring_1999. It is more limited than
these earlier works, e.g. in considering only unidirectional currents,
in ignoring the stretching of mooring components, and in ignoring the
stresses involved during mooring descent.

In addition to a fairly broad suite of functions, the package also provides
crude interactive tools for exploring simple moorings.

Conventional R help is provided, in addition to several vignettes, and a
[youtube playlist](https://www.youtube.com/playlist?list=PLgOXS4jiqJftEEw-jS_V4edXWpaojcw-J&si=xkM2cH3u_e1gdsWU).

At the moment, `mooring` only handles bottom-anchored moorings in which the top
buoyancy element is below the sub-surface.

## Installation

You can install the development version of `mooring` from
[GitHub](https://github.com/) by typing the following in an R console.
(Uncomment the first line, if the `devtools` package is not already installed
on your computer.)

``` r
# install.packages("devtools")
devtools::install_github("dankelley/mooring")
```
## Example

The following shows how to assess the knockdown of a mooring
consisting of a bottom anchor, 100 m of wire, and a 16-inch Viny
float, in a region of water depth 120 m with a constant current of 0.5
m/s (roughly 1 knot).  To learn more, (a) alter the current and
observe changes in the mooring shape, (b) set the `which` argument of
`plot.mooring()` to focus more directly on the knockdown, and (c)
explore the effects of specifying depth-dependent currents in the
`knockdown()` call. After a few steps like this, you ought to examine
the vignettes and the documentation of the package's functions, so you
can tackle a practical case of your own.

```{r example}
library(mooring)
# Design a mooring with a 16-inch Viny float attached to a bottom
# anchor with 100m of wire cable.
m <- mooring(anchor(), wire(length = 100), float("16in Viny"), waterDepth = 120)
# Segmentize wire portion (to 1m spacing).
ms <- segmentize(m)
# Apply a depth-invariant 0.5 m/s current.
msk <- knockdown(ms, u = 0.5)
plot(msk, fancy = TRUE)
```

# Acknowledgments

The mooring-element properties that are stored in the
`mooringElements` database stem from three main sources. The first was
Richard Dewey's Matlab code (see @dewey_mooring_2023 for an updated
version). The second was in spreadsheets and other documents provided
by Jay Barthelotte and Matthew Lawson of the Bedford Institute of
Oceanography ([BIO](https://www.bio.gc.ca/index-en.php)). And the
third was in spreadsheets and other documents provided by Danielle
Dempsey and Nicole Torrie of the Centre for Marine Research
([CMAR](https://cmar.ca)). These sources are designated `"Dewey"`,
`"BIO"` and `"CMAR"`, respectively, in `mooringElements`.

Conversations with Clark Richards and Chantelle Layton (both of
[BIO](https://www.bio.gc.ca/index-en.php)) were helpful in identifying data
sources and in clarifying the nature of mooring systems.


# References

Owner

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "mooring",
  "description": "Calculates the response of oceanographic moorings to horizontal currents.",
  "name": "mooring: Design and Model Oceanographic Moorings",
  "codeRepository": "https://github.com/dankelley/mooring",
  "issueTracker": "https://github.com/dankelley/mooring/issues",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "0.1.1",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.3.2 (2023-10-31)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Dan",
      "familyName": "Kelley",
      "email": "dan.kelley@dal.ca",
      "@id": "https://orcid.org/0000-0001-7808-5911"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Dan",
      "familyName": "Kelley",
      "email": "dan.kelley@dal.ca",
      "@id": "https://orcid.org/0000-0001-7808-5911"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 3.5.0"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "shiny",
      "name": "shiny",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=shiny"
    },
    "SystemRequirements": null
  },
  "fileSize": "3041.468KB",
  "relatedLink": "https://dankelley.github.io/mooring/",
  "releaseNotes": "https://github.com/dankelley/mooring/blob/master/NEWS.md",
  "readme": "https://github.com/dankelley/mooring/blob/main/README.md",
  "contIntegration": "https://github.com/dankelley/mooring/actions/workflows/R-CMD-check.yaml",
  "keywords": [
    "oceanography",
    "mooring",
    "current"
  ]
}

GitHub Events

Committers

Last synced: about 2 years ago

Issues and Pull Requests

Last synced: 6 months ago