Scripts

Siril possède une ligne de commande dans son interface graphique et la possibilité d'exécuter des scripts qui sont une liste de commandes, soit à partir de l'interface graphique, soit à partir de l'interface en ligne de commande. En général, les commandes qui modifient une seule image travaillent sur l'image actuellement chargée, donc l'utilisation de la commande load est requise dans les scripts, et les commandes qui travaillent sur une séquence d'images prennent le nom de la séquence comme argument. Si les fichiers ne sont pas nommés d'une manière que Siril détecte comme une séquence, la commande convert vous aidera.

Astuce

Le caractère Espace est le délimiteur entre les arguments. Si vous avez besoin d'avoir des espaces à l'intérieur des arguments, vous pouvez utiliser le guillemet ou le guillemet double, comme dans un shell.

Les commandes peuvent être saisies dans la ligne de commande située en bas de la fenêtre principale de Siril. Une autre méthode consiste à placer les commandes dans un fichier et à l'exécuter en tant que script. Pour exécuter le fichier à partir de l'interface graphique, ajoutez-le aux répertoires de scripts configurés ou à partir de l'interface graphique, utilisez le symbole @ de la ligne de commande comme suit :

@file_name

Certaines commandes (preprocess, stack, et toutes les commandes de sauvegarde) peuvent utiliser des noms de fichiers contenant des variables provenant de l'en-tête FITS. Le format de l'expression est expliqué en détail ici et peut être testé en utilisant la commande parse.

Utilisation des scripts

Il y a trois façons d'exécuter un script :

à partir de l'interface utilisateur graphique, en utilisant le mot clé @ sur la ligne de commande, suivi du nom du script dans le répertoire de travail actuel,
depuis l'interface graphique utilisateur, utilisez le menu Scripts,
depuis l'interface de ligne de commande (siril-cli exécutable), en utilisant l'argument -s suivi du chemin du script (voir la page man pour plus d'informations).

The scripts menu only appears if some scripts have been found in the script search directories defined either by default or by the user in the preference menu, or if scripts have been selected from the siril-scripts online repository.

Remplir la liste des scripts

Par défaut, lors de l'installation de Siril, un certain nombre de scripts sont automatiquement installés. Ces scripts intégrés, les scripts officiels, sont développés par l'équipe de développement et leur fonctionnement est garanti : ils sont destinés à couvrir des cas d'utilisation spécifiques.

Ajouter des dossiers de scripts personnalisés

Vous pouvez, bien sûr, écrire vos propres et indiquer au Siril où les trouver :

Cliquez sur l'icône Burger puis sur Préférences (ou appuyer sur Ctrl+P).

Cliquer sur la section Scripts.

Copiez sur une nouvelle ligne le chemin d'accès à l'emplacement où vous les stockerez (créez un dossier sur votre ordinateur ou indiquez un dossier existant).

Cliquez sur l'icône Rafraichir juste en dessous.

Cliquer sur Appliquer.

Vous pouvez avoir autant de dossiers définis par l'utilisateur que vous le souhaitez, il vous suffit juste de les ajouter à la liste.

Si vous venez d'ajouter un nouveau script dans l'un des dossiers et que vous souhaitez rafraîchir le menu, tapez la commande reloadscripts en ligne de commande ou ouvrez la section Preferences ‣ Scripts et utilisez l'icône Rafraîchir. Cela permet d'analyser tous les dossiers de la liste et de trouver tous les fichiers portant l'extension *.ssf.

Avertissement

Il est fortement déconseillé de stocker vos scripts personnalisés dans le même dossier que les scripts Siril intégrés. Sous Windows, ils peuvent être effacés lors de l'installation d'une nouvelle version ou empêcher une désinstallation correcte. Sous MacOS, cela casserait le bundle et empêcherait l'utilisation de Siril.

Ne vous inquiétez pas, la liste des emplacements des scripts étant stockée dans votre fichier de configuration, vous devriez les retrouver lors de l'installation d'une version plus récente.

Résolution de problèmes

Pour différentes raison il est possible que le menu Scripts ne soit pas visible. Ceci signifie que les scripts n'ont pas été trouvés. Si c'est le cas, veuillez suivre la procédure suivante.

Cliquez sur l'icône Burger puis sur Préférences.
Cliquer sur la section Scripts.
Supprimer toutes les lignes dans le champ Répertoire des scripts tel que montré dans l'illustration si dessous.
If you are using the scripts repository, deselect the Fetch and update scripts... check box, then reselect it and select the scripts you want to use.
Cliquer sur Appliquer.
Fermer et redémarrer Siril.

dialogue — Page de préférence des scripts. Les scripts sont chargé depuis les répertoires listé dans Répertoire des scripts.

Scripts intégrés

Tous les scripts intégrés doivent respecter cette structure de fichier :

Mono_Preprocessing.ssf : script pour le prétraitement des appareils photos numériques ou caméras astro monochromes, utilise les biais, les flats et les darks, aligne et empile les images. Pour l'utiliser : mettez vos fichiers (RAW ou FITs) dans les dossiers nommés lights, darks, flats et biases (dans le dossier de travail par défaut de Siril), puis lancez le script.
OSC_Preprocessing.ssf : même script que ci-dessus mais pour les appareils photos numériques ou caméras astro couleur. Pour l'utiliser : mettez vos fichiers (RAW ou FITS) dans les dossiers nommés lights, darks, flats et biases (dans le dossier de travail par défaut de Siril), puis lancez le script.
OSC_Extract_Ha.ssf : script pour le prétraitement des appareils photos numériques ou caméras astro couleur, à utiliser avec le filtre Ha ou le filtre à double bande. Ce script extrait la couche Ha de l'image couleur. Pour l'utiliser : mettez vos fichiers (RAW ou FITs) dans les dossiers nommés lights, darks, flats et biases (dans le dossier de travail par défaut de Siril), puis lancez le script.
OSC_Extract_HaOIII.ssf : même script que ci-dessus, mais extrait les couches Ha et OIII de l'image couleur. Pour l'utiliser : mettez vos fichiers (RAW ou FITs) dans les dossiers nommés lights, darks, flats et biases (dans le dossier de travail par défaut de Siril), puis lancez le script. Vous pouvez aussi utiliser le menu Traitement de l'image puis Composition RVB et mettre le résultat Ha dans le canal rouge et le résultat OIII dans les couches verte et bleue pour obtenir une image HOO.

Astuce

Pour les possesseurs de filtres SII ou dualband SII-OIII, les mêmes scripts s'appliquent. En effet, il est impossible pour un capteur couleur de voir la différence entre Ha (656.3 nm) et SII (671.6 nm), tous deux de couleur rouge.
RGB_Composition.ssf : Ce script ajouté dans la version 1.2 aligne des images monochromes avec l'alignement globale, les recadre en utilsiant leur zone commune et prend les trois premières images pour créer une image en couleur. Les images d'entrée doivent être placées seules dans un répertoire et nommées R.fit (ou avec l'extension configurée), G.fit et B.fit. Le résultat est nommé rgb.fit. Assurez-vous de supprimer le répertoire process entre chaque exécution.

Langue de scripts

Au début des scripts, et grâce à la contribution d'un utilisateur, les scripts existaient en deux versions (anglaise, et française). Lors de la sortie de Siril 1.2.0, il a été décidé de ne conserver que les scripts anglais pour des raisons de simplicité de maintenance. Nous encourageons les utilisateurs à distribuer des traductions des scripts officiels à leurs communautés respectives s'ils le jugent nécessaire.

Obtenir plus de scripts

Il y a tout un tas de scripts qui ne sont pas fournis avec l'installation de Siril. Cependant, nous avons mis en place un dépôt gitlab pour eux. Chacun est libre de s'inscrire et de proposer de nouveaux scripts. Nous les accepterons en fonction de leur pertinence : la langue utilisée doit être l'anglais.

Siril features git integration which means that it can download and synchronise a local copy of the repository. You can enable this by selecting the Enable use of the siril-scripts online repository check box in the Scripts tab of the Preferences dialog.

Selecting the check box will fetch scripts from the repository and show a list of the available scripts, categorised as either "Preprocessing" or "Processing" scripts. As there may eventually be a substantial number of scripts in the repository you need to select the ones you wish to have available in the Scripts menu. Click the check box next to the name of each script you wish to use and then press the Apply button.

The contents of any script can be viewed by double-clicking on its row in the list. It is always useful to do this to check what requirements the script may have in terms of pre-prepared directories. If you wish to modify a script, you can also use this to copy the script and paste it into your favourite text editor software. (You will need to save it in one of your local script directories.)

When the scripts repository is enabled, Siril can synchronise the local repository with the remote, either manually or automatically. If automatic updates are selected, updating will take place at application startup. Manual update is also available using the Manual update button. This will fetch any changes from the online repository and will show a list of the commit messages describing the changes, which the user must confirm to apply the update.

You can also refer to the address below to browse the scripts and download them manually if you don't wish to use the git integration. In that case you will need to manually place scripts you download into a script path known to Siril. https://gitlab.com/free-astro/siril-scripts.

Avertissement

Gardez toutefois à l'esprit que ces scripts ne sont pas nécessairement maintenus par les utilisateurs qui les ont téléchargés et qu'ils peuvent ne pas être à jour. Cela dit, amusez-vous bien.

Rédiger votre propre script

Un fichier script est un simple fichier texte portant l'extension *.ssf.

Writing a script is not difficult. It is a succession of calls to commands that will be executed sequentially. Each command must be executed without returning an error, otherwise the script stops. It is therefore strongly recommended to use the list of commands to know the syntax and the number of parameters needed. Also, some commands are not scriptable and are indicated with the Non scriptable icon. It can also be useful to test each script line in the Siril command line. You may wish to read the provided scripts or view (or even modify) scripts from the repository as examples.

Each script should contain a comment header containing information about the script. An example of this is provided below.

############################################
#
# Script for Siril 1.0
# July 2020
# (C) Cyril Richard
# Mono_Preprocessing_WithoutDark v1.0
#
########### PREPROCESSING SCRIPT ###########
#
# Script for mono camera preprocessing
#
# Needs 3 sets of RAW images in the working
# directory, within 4 directories:
#   biases/
#   flats/
#   lights/
#
############################################

Below the comment header the first command should be requires. This specifies the minimum version of Siril required to use the script. For example:

requires 0.99.4

After this you can start the actual script. Commands go on a line of their own, and you can comment your script using lines starting with #.

Each new script created in this way should be placed in a user-defined folder for Siril to find them. If you believe your script is of benefit to the wider Siril community you may submit it to the script repository. Instructions on doing so are found in the repository README.