Getting started

This guide assumes you already have a working Apache configuration capable of talking to an instance of a SuperDARN Catalogue API.

Setting up the app

The repository contains a working index.html file, however you may wish to create your own (for instance, if you have specific style sheets you want to use). The repository also contains a number of Javascript and CSS files, some of which are snapshots of third party software e.g. JQuery. The provided versions have been tested and work with this app. You may use different versions than those provided, but be advised that in some cases, the use of different versions may prevent certain parts of the app from working or even prevent the app from working as a whole.

Required Javascript libraries

The following Javascript libraries need to be called:

  • /js/jquery/jquery-1.12.4.min.js
  • /js/jquery/jquery-ui.min.js
  • /js/flot/jquery.flot.min.js
  • /js/flot/jquery.flot.selection.min.js
  • /js/flot/jquery.flot.crosshair.min.js
  • /js/flot/jquery.flot.navigate.min.js
  • /js/sdcat/SDCat.js
  • /js/SDCat.App.js
  • /js/SDCat.CoveragePlot.js
  • /js/catalogue-plot/CataloguePlot.js

Required CSS libraries

The following CSS libraries need to be called:

  • /css/jquery-ui/jquery-ui.min.css
  • /css/SDCat.App.css
  • /css/catalogue-plot/CataloguePlot.css

Other requirements

Your index.html page requires a container div into which the app shall be placed. This div should have the ID sdCatContainer, though if you decide to use a different ID, this can be specified in the app initialisation.

<div id='sdCatContainer'></div>

Once all this is in place, the app can be initialised.

Table Of Contents

Previous topic

SuperDARN Catalogue Coverage App Documentation

Next topic

Initialising the app

This Page