Northern Lights Forecast Plugin Documentation
Complete guide to using the NPF WordPress plugin for real-time aurora forecast data, KP index, solar wind, and location-specific weather conditions.
Table of Contents
Installation
Step 1: Install the Plugin
- Download the plugin here
- Go to WordPress Admin → Plugins → Add New → Upload Plugin
- Upload the plugin zip file and activate it
Step 2: Configure API Keys
- Go to WordPress Admin → Northern Lights → Settings
- Enter your OpenWeatherMap API key (required for weather data)
- Save settings
Note: The plugin uses free APIs for aurora data (NOAA, auroras.live), but requires an OpenWeatherMap API key for location-specific weather forecasts. Get your free API key at openweathermap.org.
Shortcodes
Use these shortcodes to display aurora forecast data anywhere on your WordPress site.
Basic Metrics
KP Index
[kp_index]Displays the current planetary K-index (0-9 scale).
Main KP Display
[main_kp]Large, prominent KP index display with level description.
Solar Wind Speed
[solar_winds]Shows current solar wind speed in km/s.
Aurora Probability
[aurora_probability]Shows the calculated probability of aurora visibility (percentage).
Current Conditions
Current Space Weather Conditions
[current_conditions]Displays current space weather conditions including KP, solar wind, and other metrics.
Forecasts
Three-Day Forecast
[three_day_forecast]Shows a 3-day forecast for Tromsø.
Location-Specific 3-Day Forecasts
[three_day_forecast_lofoten][three_day_forecast_alta]3-day forecasts for Lofoten and Alta respectively.
27-Day Forecast
[27day_forecast] or [twenty_seven_day_forecast]Displays a 27-day aurora forecast grid.
Magnetic Field Components
Bz Component
[bz_factor]Displays the Bz component of the interplanetary magnetic field. Negative values favor aurora formation.
By Component
[by_component]Displays the By component of the interplanetary magnetic field.
Bx Component
[bx_component]Displays the Bx component of the interplanetary magnetic field.
BT Field
[bt_field]Displays the total strength of the interplanetary magnetic field in nanotesla.
Configuration
Settings
Access plugin settings at WordPress Admin → Northern Lights → Settings
OpenWeatherMap API Key
Required for location-specific weather forecasts. Get your free API key at openweathermap.org.
Note: The plugin uses free APIs for aurora data (NOAA, auroras.live), but requires an OpenWeatherMap API key for location-specific weather forecasts. After adding your API key, it may take up to 2 hours for it to become active.
Examples
Basic Usage
Display key metrics on your page:
[main_kp]
[current_conditions]
[three_day_forecast]
[27day_forecast]With Components
Include magnetic field components:
[kp_index]
[bz_factor]
[by_component]
[bx_component]
[bt_field]Using in Widgets
All shortcodes work in WordPress widgets. Add them to your sidebar or footer using a Text widget.