FederAstro

FAQ · PixInsight scripts

Setting up · the questions run through the night

PixInsight scripts, questions answered.

Installing and updating PixInsight scripts and modules from a repository, what to do when something doesn’t show up, and the FederAstro tools in particular. Every answer has its own link: the # after each question.

Setting up

Installing and updating

one address, then forget about it

How do I install PixInsight scripts and modules from a repository? #

In PixInsight, open Resources ▸ Updates ▸ Manage Repositories, click Add and paste the repository’s address (for FederAstro: https://federastro.com/pixinsight/), then click OK. Run Resources ▸ Updates ▸ Check for Updates and select the updates it finds. PixInsight installs them when you exit it (on Windows, accept the permission prompt) and then starts again by itself, with the modules installed and the scripts in the Script menu. From then on, Check for Updates offers every new version.

Check for Updates finds nothing, or the tools don’t appear. What now? #

First check the address under Manage Repositories: it must be exactly https://federastro.com/pixinsight/. Updates are offered once: if you already applied them, the tools are installed, so look under Script ▸ FederAstro and Process ▸ FederAstro. Updates are installed when you exit PixInsight, so new tools appear after it has started again. If script entries or icons look stale, use Regenerate in Script ▸ Feature Scripts. The modules exist for Windows (64-bit) and macOS on Apple silicon; on Linux or an Intel Mac only the scripts install.

How do I update them, or remove a module? #

To update, run Resources ▸ Updates ▸ Check for Updates; PixInsight can also check automatically when it starts. To remove a module, use Process ▸ Modules ▸ Uninstall Modules. To stop receiving updates, remove the repository under Manage Repositories.

Which PixInsight versions and systems are supported? #

All seven tools need PixInsight 1.9.5 or later. The scripts (Acquisition Card, Tilt Doctor) run on Windows, macOS and Linux. The modules (Finderscope, Mask Lab, Palette Lab, Tonight, Touch Stretch) are built for Windows (64-bit) and macOS on Apple silicon. Palette Lab was a script up to version 0.7.6; on Linux and Intel Macs, an already installed copy of that script keeps working, without further updates.

While the subs come in

PixInsight scripts in general

nothing to do but wait, and read

What’s the difference between a PixInsight script and a module? #

A script is a program written in JavaScript that runs inside PixInsight and appears under the Script menu; the same script runs on every system PixInsight supports. A module is a compiled add-on, built separately for each system, that adds new processes under the Process menu; compiled, it runs at full speed. Both are installed and updated the same way, from a repository.

How do I add a single script file by hand? #

Put the script’s .js file in a folder of its own, open Script ▸ Feature Scripts, click Add and choose that folder. PixInsight adds every script in it that has a #feature-id line to the Script menu, in the submenu that line names. A repository is the better route when there is one: it installs, verifies and updates everything for you.

Are third-party PixInsight scripts safe? What does “Certified Developer” mean? #

A PixInsight Certified Developer is a developer certified by Pleiades Astrophoto, the makers of PixInsight, with the right to sign code that PixInsight recognizes as valid. A signature guarantees authenticity and integrity: the code comes from that developer and hasn’t been changed since. It says nothing about quality. PixInsight always refuses a repository whose signature is invalid, warns you before downloading anything from an unsigned one, and checks each script’s and module’s signature. Everything in the FederAstro repository is signed by a Certified Developer (afederastro).

Astronomical night

Troubleshooting

it’s always 3 a.m. when something breaks

PixInsight says the repository has an invalid signature. #

PixInsight never downloads from a repository whose signature it can’t verify. A common cause is an older PixInsight that doesn’t know the developer yet: update PixInsight to 1.9.5 or later, then run Check for Updates again. If the message stays, please report it on GitHub with the text from the Process Console.

A module is missing after an update. #

Updates are installed when you exit PixInsight (on Windows, accept the permission prompt), and modules load when it starts again. If the module is still missing, make sure your system is one the modules are built for (Windows 64-bit, or macOS on Apple silicon) and that PixInsight is 1.9.5 or later, then look in the Process Console for a message about it and report it on GitHub.

The next morning, at the desk

The FederAstro tools

coffee, masters, palettes

Which tool is for what? #

  • Palette Lab: compare twenty narrowband palettes (SHO, HOO, Foraxx, Magma and more) side by side from your Hα, OIII and SII masters, and build the one you like.
  • Mask Lab: paint, select and refine masks at full resolution, then apply them.
  • Touch Stretch: stretch an image by touching it, with a live full-resolution preview.
  • Finderscope: a panel of icon tiles for the processes and scripts you use, and saved settings you apply with a click.
  • Acquisition Card: AstroBin’s acquisition CSV and a session summary from the headers of your subs.
  • Tilt Doctor: sensor tilt from the size of the stars across your subs.
  • Tonight: a quick look while you image, with each filter stacked as the subs arrive, a palette preview, and flags for the subs to leave out.

Are they free? Can I use them for commercial work? #

All seven are free. Palette Lab is licensed CC BY-NC 4.0: free for non-commercial use. The other six are free for any use, including commercial imaging work.

Where is the documentation? #

It’s built in: select a tool under FederAstro in PixInsight’s Process Explorer to open its documentation in the Documentation Browser, or press F1 in the tool’s window where it offers help. The same documentation is on GitHub, and each tool has its own page on this site with its features and changelog.

How do I report a bug or ask for a feature? #

Open an issue on GitHub; the form asks for the tool, its version, your PixInsight version and system. Copying any messages from PixInsight’s Process Console into it helps a lot.