Skip to content

Latest commit

 

History

History
126 lines (101 loc) · 3.27 KB

README.md

File metadata and controls

126 lines (101 loc) · 3.27 KB
Raw

SigPlot

License NodeJS with Grunt PRs Welcome npm version

SigPlot provides fast, interactive plotting for software defined radio applications using HTML5.

SigPlot plotting the FFT of a signal

Getting Started

<html>
  <head>
    <title>SigPlot Standalone</title>
    <style>
      #plot {
        width: 600px;
        height: 400px;
      }
    </style>
  </head>
  <body>
    <div id="plot"></div>
    <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/sigplot/dist/sigplot-debug.js"></script>
    <script type="text/javascript">
      var options = {};
      var plot = new sigplot.Plot(document.getElementById('plot'), options);
    </script>
  </body>
</html>

Demos

Execute

npm run serve

Then open http://localhost:1337/examples.

WebPack Quick Start

These instructions assume you have Node.js/NPM correctly installed on your system.

First install webpack:

npm install webpack -g

Then create a project for the SigPlot demo and install sigplot.

mkdir sigplot-webpack
cd sigplot-webpack
npm install sigplot

Next, create a file called demo.js with the following contents:

let sigplot = require("sigplot");
let options = {};
let plot = new sigplot.Plot(document.getElementById('plot'), options);

Then, create a file called index.html with the following contents:

<html>
  <head>
    <title>SigPlot Webpack</title>
    <style>
      #plot {
        width: 600px;
        height: 400px;
      }
    </style>
  </head>
  <body>
    <div id="plot"></div>
    <script type="text/javascript" src="bundle.js" charset="utf-8"></script>
  </body>
</html>

Use webpack to compile the bundle:

webpack ./demo.js bundle.js

Then open index.html in your webbrowser.

Help

Join the discussion on Slack.

Contributing

See CONTRIBUTING.md.

License

Licensed to the LGS Innovations (LGS) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. LGS licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.