Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joelcolucci/sailboat-statistics
Functions to calculate common sailboat evaluative statistics
https://github.com/joelcolucci/sailboat-statistics
measurements sailboat statistics
Last synced: about 1 month ago
JSON representation
Functions to calculate common sailboat evaluative statistics
- Host: GitHub
- URL: https://github.com/joelcolucci/sailboat-statistics
- Owner: joelcolucci
- License: mit
- Created: 2018-08-27T16:25:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-03T14:59:13.000Z (over 6 years ago)
- Last Synced: 2024-11-10T23:39:45.578Z (about 1 month ago)
- Topics: measurements, sailboat, statistics
- Language: JavaScript
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sailboat Statistics [](https://www.npmjs.com/package/sailboat-statistics)
> Functions to calculate common sailboat statistics
## Installation
```
# NPM
npm install sailboat-statistics --save
# Yarn
yarn add sailboat-statistics
```
## Getting Started
```javascript
import { getTheoreticalHullSpeed } from sailboat-statistics;
let lengthOfWaterline = 30;
let hullSpeed = getTheoreticalHullSpeed(lengthOfWaterline);
console.log(hullSpeed); // 7.34
```
## Documentation
### `getTheoreticalHullSpeed(lwl)`
| Parameters | Description |
| --- | --- |
| lwl | Length of waterline in feet |
### `getBallastDisplacementRatio(displacement, ballast)`
| Parameters | Description |
| --- | --- |
| displacement | Displacement in pounds |
| ballast | Ballast in pounds |
### `getDisplacementLengthRatio(displacement, lwl)`
| Parameters | Description |
| --- | --- |
| displacement | Displacement in pounds |
| lwl | Length of waterline in feet |
### `getSailAreaDisplacementRatio(sailArea, displacement)`
| Parameters | Description |
| --- | --- |
| sailArea | Sail area in square feet |
| displacement | Displacement in pounds |
### `getCapsizeRatio(beam, displacement)`
| Parameters | Description |
| --- | --- |
| beam | Beam in feet |
| displacement | Displacement in pounds |
### `getMotionComfort(loa, lwl, beam, displacment)`
| Parameters | Description |
| --- | --- |
| loa | Length overall in feet |
| lwl | Length of waterline in feet |
| beam | Beam in feet |
| displacement | Displacement in pounds |
## License
MIT License Copyright (c) 2018 Joel Colucci