# aurora-probability-calculation

> A library to predict the probability of an aurora boreales event for the future

Latest version **0.0.6** (published 2016-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install aurora-probability-calculation
pnpm add aurora-probability-calculation
yarn add aurora-probability-calculation
bun add aurora-probability-calculation
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2016-06-11 |
| First published | 2016-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Stefan B. |
| Maintainers | stefan-b |
| Keywords | Aurora, Probability |

## Links

- npm: https://www.npmjs.com/package/aurora-probability-calculation
- Repository: https://github.com/B-Stefan/aurora-probability-calculation
- Homepage: https://github.com/B-Stefan/aurora-probability-calculation#readme
- Issues: https://github.com/B-Stefan/aurora-probability-calculation/issues
- npm.io page: https://npm.io/package/aurora-probability-calculation

## Dependencies (2)

- [node-svm](https://npm.io/package/node-svm.md) ^2.1.7
- [geomagnatic-to-kp-index-converter](https://npm.io/package/geomagnatic-to-kp-index-converter.md) ^1.1.0

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2016-06-11
- 0.0.1 (beta) — 2016-05-16
- 0.0.5 — 2016-05-16
- 0.0.4 — 2016-05-16
- 0.0.3 — 2016-05-16
- 0.0.2 — 2016-05-16

## README

# aurora-probability-calculation
A library to get the probability of an northern light event for a specific location and a given [kpIndex]( http://www.swpc.noaa.gov/products/planetary-k-index) 
#Installation 

```
  npm install aurora-probability-calculation
```

#Example


```javascript


import {predict} from "aurora-probability-calculation"

const gLat = 55.60; // Geomagnatic latitude Malmö, Schweden , see https://en.wikipedia.org/wiki/Geomagnetic_lat
const kpIndex = 6; // Kp Index see  http://www.swpc.noaa.gov/products/planetary-k-index

predict(gLat,kpIndex).then((result)=>{
  console.log("Probability for the gLat " + gLat + " and kpIndex of: " + kpIndex + " is ===> ", result)
}).catch((e)=>{
  console.error(e)
});

//Output: Probability for the gLat 55.6 and kpIndex of: 6 is ===>  0.8988385082835078


```


#Prediction method
I tried several solutions all based on some kind of learning algorithm for example you find in this repository implementations of the following libaries: 

* Brain-js - A very simple neuronal network  [Branch:feature-brain-js](https://github.com/B-Stefan/aurora-probability-calculation/tree/feature-brain-js)
* convnetjs - More complex neuronal network libary  [Branch:feature-convnetjs](https://github.com/B-Stefan/aurora-probability-calculation/tree/feature-convnetjs)
* smr - multiple regression lib   [Branch:feature-smr](https://github.com/B-Stefan/aurora-probability-calculation/tree/feature-smr)
* synaptic - good neuronal network lib  [Branch:feature-synaptic](https://github.com/B-Stefan/aurora-probability-calculation/tree/feature-synaptic)



#Licence

* MIT

---
_Source: https://npm.io/package/aurora-probability-calculation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._