dirtybomb
Version:
A dirty bomb model
111 lines (101 loc) • 7.5 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl">
<title data-ice="title">API Document</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
</head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<a href="test.html" data-ice="testLink">Test</a>
<a data-ice="repoURL" href="https://github.com/austincawley/dirtybomb" class="repo-url-github">Repository</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Bomb.js~Bomb.html">Bomb</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Dirtybomb.js~Dirtybomb.html">Dirtybomb</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/NuclearMaterial.js~NuclearMaterial.html">NuclearMaterial</a></span></span></li>
<li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">Dispersion</div><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Dispersion/Atmosphere.js~Atmosphere.html">Atmosphere</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Dispersion/DynamicGaussianDecayPuff.Spec.js~DynamicGaussianDecayPuff.html">DynamicGaussianDecayPuff</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Dispersion/DynamicGaussianPuff.js~DynamicGaussianPuff.html">DynamicGaussianPuff</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Dispersion/GaussianDecayPlume.js~GaussianDecayPlume.html">GaussianDecayPlume</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Dispersion/GaussianDecayPuff.js~GaussianDecayPuff.html">GaussianDecayPuff</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Dispersion/GaussianPlume.js~GaussianPlume.html">GaussianPlume</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Dispersion/GaussianPuff.js~GaussianPuff.html">GaussianPuff</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/Dispersion/Source.js~Source.html">Source</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-Vector">Vector</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-integrate">integrate</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-Dispersion">Dispersion</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-SourceType">SourceType</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-Coord">Coord</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-STD_Y_COEFF">STD_Y_COEFF</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-STD_Z_COEFF">STD_Z_COEFF</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-Stat">Stat</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><div data-ice="index" class="github-markdown"><h1 id="dirtybomb">dirtybomb</h1>
<p><a href="https://travis-ci.org/austincawley/dirtybomb"><img src="https://travis-ci.org/austincawley/dirtybomb.svg?branch=master" alt="Build Status"></a> <a href="https://doc.esdoc.org/github.com/austincawley/dirtybomb/"><img src="https://doc.esdoc.org/github.com/austincawley/dirtybomb/badge.svg" alt="Doc Status"></a>
<a href="https://www.npmjs.com/package/dirtybomb"><img src="https://img.shields.io/npm/v/dirtybomb.svg" alt="npm"></a> <img src="https://img.shields.io/npm/l/dirtybomb.svg" alt="License"><br>Stevens Summer Scholars Research Project under <a href="http://blog.nuclearsecrecy.com/">Dr. Alex Wellerstein</a>.
The research aims to create a client-side library to model the impact of a dirty bomb.<br>Written in ES6. </p>
<p><strong>Use in browser:</strong> use the rolled up files in the build/ directory<br><strong>Use in node:</strong> use the rolled up files in the dist/ directory. It has been babel-ed to es5 </p>
<h2 id="updates-current-research">Updates / Current Research</h2>
<p>Currently writing tests and then moving towards visualization. </p>
<h2 id="goals">Goals</h2>
<ul>
<li>Dispersion Model</li>
<li>Radioactive release Model</li>
<li>Visualization Prototype</li>
</ul>
<h2 id="building">Building</h2>
<p>Loosely trying to base this on how d3 manages its modularity.<br>Builds to build/ and dist/ </p>
<ul>
<li>Requires node / babel / all that jazz</li>
<li>Run using npm: <code>npm run build</code> </li>
</ul>
<h2 id="testing">Testing</h2>
<p>test/<br>Using chai and mocha </p>
<ul>
<li><code>npm test</code></li>
</ul>
<h2 id="documentation">Documentation</h2>
<p>Using esdoc. You should be able to create some nice documentation yourself with an easy command!</p>
<ul>
<li><code>npm run doc</code></li>
<li><code>npm servedocs</code> to locally host them</li>
</ul>
<h2 id="resources">Resources</h2>
<ul>
<li><a href="https://goo.gl/ZqFHiE">Understanding Radioactive Aerosols and Their Measurement</a></li>
<li><a href="http://www.src.com/">CALPUFF Modeling System</a></li>
</ul>
<p><!--[license]: https://github.com/austincawley/dirtybomb/blob/master/LICENSE.md-->
</p>
</div>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.4.7)</span></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>