supercell-wx/README.md
Michael c5091a3c43
Update the README with more information
Added the documentation link to help guide users who're new. Re-organized Arch and derivatives under supported operating systems. Added necessary dependencies. Added a short FAQ.
2023-09-01 20:28:23 -04:00

2.7 KiB

Supercell Wx

CI Documentation Status Discord GitHub Sponsor

Supercell Wx is a free, open source application to visualize live and archive NEXRAD Level 2 and Level 3 data, and severe weather alerts. It displays continuously updating weather data on top of a responsive map, providing the capability to monitor weather events using reflectivity, velocity, and other products.

Please be sure to check out the documentation before getting started: Supercell-Wx Documentation

image

Supported Platforms

Supercell Wx supports the following 64-bit operating systems:

  • Windows 10 (1809 or later)
  • Windows 11
  • Linux
    • Arch Linux (EndeavourOS, SteamOS [Steam Deck], and other Arch derivatives)
    • Fedora Linux 34+
    • openSUSE Tumbleweed
    • Ubuntu 22.04+
    • Most distributions supporting the GCC Standard C++ Library 11+

Linux Dependencies

Supercell Wx requires the following Linux dependencies:

  • Linux/X11 (Wayland works fine too) with support for GCC 11 and OpenGL
  • X11/XCB libraries including xcb-cursor

FAQ

Frequently asked questions:

  • Q: Why is the map black when loading for the first time?

    • A. You must obtain a free API key from either (or both) MapTiler which reuqires no credit/debit card, or Mapbox which does require a credit/debit card, but as of writing, you will get 200K free requests per month, which you will never go over by yourself.
  • Q: How come when I change my color table or API key, nothing happens after hitting apply?

    • A. As of right now, you must restart Supercell-Wx in order to apply these changes. In future iterations, this will no longer be an issue.
  • Q. Is it possible to get dark mode?

    • A. In Windows, make sure to set the flag -style fusion at the end of the target path of the .exe
      • Example: C:\Users\Administrator\Desktop\Supercell-Wx\bin\supercell-wx.exe -style fusion
    • A. In Linux, if you're using KDE, it should automatically follow your theme settings.