https://github.com/orvn/scutoid

Calculate the volume or surface area of a scutoid
https://github.com/orvn/scutoid

Last synced: 12 days ago
JSON representation

Calculate the volume or surface area of a scutoid

• Host: GitHub
• URL: https://github.com/orvn/scutoid
• Owner: orvn
• License: apache-2.0
• Created: 2023-08-07T02:49:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-07T22:01:11.000Z (over 1 year ago)
• Last Synced: 2024-04-14T01:00:35.349Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 68.4 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Scutoid

![Scutoid graph image](assets/images/scutoids.png)

A package to calculate the volume or surface area of a scutoid in Javascript.

Scutoids are a geometric shape discovered in 2018 that represent the shapes that epithelial cells may take within human tissues. This package helps in calculating their volume and surface area.

## Installation

```bash

npm i --save scutoid

```

## Usage

First, import the Scutoid class from the package

```js

const Scutoid = require('scutoid');

```

Next, create a new instance of the Scutoid class

```js

const myScutoid = new Scutoid(prismHeight, prismFaceLength, triangleDepth);

```

where:

- `prismHeight` - height of the pentagonal prism, i.e., the overall height of the scutoid

- `prismFaceLength` - length of each face of the regular pentagon, from the pentagonal prism that will later become a scutoid

- `triangleDepth` - depth of the triangular prism, which is subtracted from the pentagonal prism, to create the scutoid

Once the scutoid instance is created, you can calculate its volume and surface area by supplying numbers as arguments:

```js

const volume = myScutoid.volume();

const surfaceArea = myScutoid.surface();

```

## Example

```js

const Scutoid = require('scutoid');

const myScutoid = new Scutoid(10, 5, 7);

console.log(`Volume: ${myScutoid.volume()}`);

console.log(`Surface area: ${myScutoid.surface()}`);

```

## Development and Testing

This project uses mocha for testing. 

Run tests with `npm test`.

#### TBD

- Support irregular top and bottom prism faces

- Consider adding prisma, tronco, frustum, prismatoide, escutoide

- Tests with Mocha