Skip to content

Update local run documentation for wasm and fix script permissions#1012

Merged
accius merged 2 commits into
accius:Stagingfrom
alanhargreaves:update-local-run
May 26, 2026
Merged

Update local run documentation for wasm and fix script permissions#1012
accius merged 2 commits into
accius:Stagingfrom
alanhargreaves:update-local-run

Conversation

@alanhargreaves
Copy link
Copy Markdown
Collaborator

What does this PR do?

Updates the Installation section of the top-level README.md with a note to run scripts/fetch-wasm.sh if you want clients on your local server to use the client-side propagation calculation module.

Also adds execute permission to scripts/fetch-wasm.sh.

I can't be the only one that needed to spend way more time than necessary to figure this out.

Type of change

  • Bug fix
  • New feature
  • Performance improvement
  • Refactor / code cleanup
  • Documentation
  • Translation
  • Map layer plugin

How to test

Go to a local client and verify that the VOACAP panel says that it is using "WASM" rather than "EST"

Checklist

Documentation and permissions change only.

Screenshots (if visual change)

image

Add a small section  to the Installartion section of the top level README on how to use fetch-wasm.sh to have your local clients use the client side p533 module.
@MichaelWheeley
Copy link
Copy Markdown
Collaborator

MichaelWheeley commented May 24, 2026

@alanhargreaves
Ran
gh pr checkout 1012

but the +x wasn't enabled, had to manually change, shouldn’t your change already have fixed that?

ls -la scripts
total 120
drwxrwxr-x  3 mrw mrw  4096 May 23 15:25 .
drwxrwxr-x 26 mrw mrw  4096 May 23 15:46 ..
-rw-r--r--  1 mrw mrw  2024 May 23 15:25 fetch-wasm.sh

had to
chmod +x scripts/fetch-wasm.sh
before
sudo ./scripts/fetch-wasm.sh

mrw@MRWRASPPI3022026:~/openhamclock $ sudo ./scripts/fetch-wasm.sh
→ fetch-wasm: downloading from https://github.com/accius/openhamclock/releases/download/wasm-latest...
✓ fetch-wasm: installed to public/wasm/
-rw-r--r-- 1 root root  66K May 23 21:02 p533.mjs
-rw-r--r-- 1 root root 202K May 23 21:02 p533.wasm
mrw@MRWRASPPI3022026:~/openhamclock $ 

@alanhargreaves
Copy link
Copy Markdown
Collaborator Author

alanhargreaves commented May 24, 2026

Why would you need to sudo it? It ran just fine as me. I am assuming that you have write access to your own copy of the repo. If you look at the diffs, the only difference teh script is the mode change.

@alanhargreaves
Copy link
Copy Markdown
Collaborator Author

I've modified the text to say

If you want your clients (using your local server) to use the p533 modules for client side propagation calculation rather than the very rough estimates (which are based on band and time of day), run the following as the user who can write to your repository.

@MichaelWheeley
Copy link
Copy Markdown
Collaborator

MichaelWheeley commented May 24, 2026

@alanhargreaves
I did a clean installation, was previously mistaken I think and gh pr checkout 1012 had not been applied hence the +x requirement. sudo not required after clean install.
ran scripts/fetch-wasm.sh and npm start but still see EST, did I miss something?

from server log
image

image
npm ci (was previously ran)

mrw@MRWRASPPI3022026:~/openhamclock $ gh pr checkout 1012
From https://github.com/accius/openhamclock
 * branch            refs/pull/1012/head -> FETCH_HEAD
Already up to date.
mrw@MRWRASPPI3022026:~/openhamclock $ scripts/fetch-wasm.sh
→ fetch-wasm: downloading from https://github.com/accius/openhamclock/releases/download/wasm-latest...
✓ fetch-wasm: installed to public/wasm/
-rw-r--r-- 1 mrw mrw  66K May 24 09:40 p533.mjs
-rw-r--r-- 1 mrw mrw 202K May 24 09:40 p533.wasm

npm start

.env

# ITURHFProp service URL (for advanced propagation predictions)
# Override only if self-hosting your own ITURHFProp service.
ITURHFPROP_URL=https://proppy-production.up.railway.app

seen in server log

[ITURHFProp] Disabled — endpoint at https://proppy-production.up.railway.app returned
HTML, not JSON. Falling back to browser WASM + heuristic.

Copy link
Copy Markdown
Owner

@accius accius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Alan — useful pointer to have in the README, easy to miss otherwise. CI green, diff is minimal (10+/0-, plus +x on scripts/fetch-wasm.sh).

A few small editorial things before merge — none blocking:

  1. Typo: "run teh following" → "the".
  2. Phrasing: "as the user who can write to your repository" — repository reads like a git operation, but the script writes WASM artifacts into the install directory. Maybe "as a user with write access to your install directory" (or public/wasm/).
  3. Heading: "Enabling Client-side Propagation Calculation (without having to build it)" is a long H3. The parenthetical could move to the body.
  4. Placement: the new section sits between npm run dev and the Table of Contents, which interrupts the install flow before the TOC even renders. It would read more naturally as a subsection under Install & run, or grouped with the other optional-feature notes further down.

scripts/fetch-wasm.sh going from 100644100755 is correct.

Happy to merge once the typo/phrasing tweaks are in. Or merge as-is and follow up — your call.

— K0CJH

@accius
Copy link
Copy Markdown
Owner

accius commented May 24, 2026

@alanhargreaves Agreed with the Automated Triage above. Please take a look at those notes and once fixed feel free to merge this.

@accius accius merged commit faddc38 into accius:Staging May 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants