### Build and Install Siril with Ninja Source: https://siril.readthedocs.io/en/stable/_sources/installation/source.rst.txt Compiles Siril using Ninja after Meson setup and then installs it. These commands should be run from the build directory. ```bash cd _build ninja ninja install ``` -------------------------------- ### Path Parsing Syntax Example Source: https://siril.readthedocs.io/en/stable/Pathparsing.html This syntax allows dynamic matching of calibration files based on instrument and filter information. It's useful for managing multiple setups. ```bash ~/astro/masters/flats/$INSTRUME:%s$_$TELESCOP:%s$/$FILTER:%s$/FLAT_bin$XBINNING:%d$.fit ``` -------------------------------- ### Configure Autotools Build and Installation Path Source: https://siril.readthedocs.io/en/stable/installation/source.html Customize the Autotools build process by passing options to `autogen.sh`. This example sets compiler flags for optimization and specifies a custom installation prefix. ```bash CFLAGS='-mtune=native -O3' ./autogen.sh --prefix=/opt ``` -------------------------------- ### Get Recommended PyTorch Backend Source: https://siril.readthedocs.io/en/stable/Python-API.html Determines the recommended PyTorch backend and installation parameters, considering GPU capabilities like CUDA, ROCm, XPU, and MPS. ```python from sirilpy.gpuhelper import TorchHelper torch_helper = TorchHelper() backend_info = torch_helper.get_recommended_backend() print(f"Recommended PyTorch backend info: {backend_info}") ``` -------------------------------- ### Add Siril PPA and Install on Ubuntu/Linux Mint Source: https://siril.readthedocs.io/en/stable/_sources/installation/linux.rst.txt Add the Siril PPA repository to get the newer version and then update apt and install Siril. This is the preferred method for Ubuntu or Linux Mint. ```bash sudo add-apt-repository ppa:lock042/siril sudo apt-get update sudo apt-get install siril ``` -------------------------------- ### Build Siril from Source with Autotools Source: https://siril.readthedocs.io/en/stable/_sources/installation/source.rst.txt Standard procedure to build Siril from source after downloading and installing prerequisites. Use with superuser privileges for 'make install'. ```bash ./autogen.sh make make install ``` -------------------------------- ### Install Siril using Homebrew Source: https://siril.readthedocs.io/en/stable/_sources/installation/macos.rst.txt Use this command to install Siril via Homebrew. Ensure Homebrew is installed first. ```bash brew install siril ``` -------------------------------- ### Example Wavelet Transform and Reconstruction Source: https://siril.readthedocs.io/en/stable/processing/atrouwavelets.html An example demonstrating the command-line usage for computing 6 wavelet layers with the bspline algorithm and then reconstructing the image with specific weights. ```bash wavelet 6 2 wrecons 31 5 1 1 1 1 ``` -------------------------------- ### Stacking Default Name Example Source: https://siril.readthedocs.io/en/stable/preferences/preferences_gui.html Demonstrates how to construct a default stacking name using FITS header keywords and sequence name. The example uses `$seqname$`, `$LIVETIME:%d$s`, and a sample FITS header to show the resulting filename. ```text r_pp_light_stacked_3900s.fit ``` -------------------------------- ### Install JAX with Hardware Acceleration Source: https://siril.readthedocs.io/en/stable/Python-API.html Installs the appropriate JAX variant (CPU, CUDA, ROCm, etc.) based on detected hardware. Use this to ensure correct JAX installation for your system. Optionally specify a variant, version constraint, or force reinstallation. ```python sirilpy.gpuhelper.JaxHelper().install_jax(force_variant='jax[cuda]', version_constraint='>=0.4.0', force_reinstall=True) ``` -------------------------------- ### Ensure Installation of Tifffile Module Source: https://siril.readthedocs.io/en/stable/scripts/Python-scripts.html Use `ensure_installed()` to verify and install the 'tifffile' module if it's not already present. This method attempts to import the module and installs it if the import fails. The delay only occurs on the first run. ```python s.ensure_installed("tifffile") import tifffile ``` -------------------------------- ### Install ONNX Runtime Source: https://siril.readthedocs.io/en/stable/Python-API.html Installs the appropriate ONNX Runtime package based on the system configuration. Use the 'force' parameter to re-install even if already present. ```python from sirilpy.gpuhelper import install_onnxruntime # Install ONNX Runtime, forcing reinstallation if needed success = install_onnxruntime(force=True) print(f"Installation successful: {success}") ``` -------------------------------- ### Install PyTorch Source: https://siril.readthedocs.io/en/stable/Python-API.html Installs PyTorch with a specified configuration, including CUDA version, extra index URL, and specific packages. ```python from sirilpy.gpuhelper import TorchHelper torch_helper = TorchHelper() # Install PyTorch with specific CUDA version and index URL torch_helper.install_torch(cuda_version='cu118', extra_index_url='https://download.pytorch.org/whl/cu118') print("PyTorch installation initiated.") ``` -------------------------------- ### Example of a constructed filename Source: https://siril.readthedocs.io/en/stable/_sources/Pathparsing.rst.txt An example of a filename generated using the path parsing syntax. ```text NGC_7023_L_57x120sec_G100_O50_T-9°C_2023-10-07 ``` -------------------------------- ### Example of a constructed master flat file path Source: https://siril.readthedocs.io/en/stable/_sources/Pathparsing.rst.txt An example of a file path generated for a master flat file using the path parsing syntax. ```text ~/astro/masters/flats/ZWO_ASI294MC_Pro_61EDPH/DualBand/FLAT_bin1.fit ``` -------------------------------- ### Install Build Dependencies Source: https://siril.readthedocs.io/en/stable/installation/source.html List of essential build tools and libraries required to compile Siril from source. These can often be installed via a package manager. ```bash git, autoconf, automake, libtool, intltool, pkg-tools, make, cmake, gcc, g++ ``` -------------------------------- ### Evaluated Path Example Source: https://siril.readthedocs.io/en/stable/Pathparsing.html This shows how the path parsing syntax from the previous example would be resolved with specific instrument and filter values. ```bash ~/astro/masters/flats/ZWO_ASI294MC_Pro_61EDPH/DualBand/FLAT_bin1.fit ``` -------------------------------- ### Install Siril Dependencies Source: https://siril.readthedocs.io/en/stable/installation/windows.html Download and execute the script to install Siril's dependencies. This script fetches the latest dependencies, which are generally compatible with stable branches. ```bash curl -s -o siril-deps.sh https://gitlab.com/free-astro/siril/-/raw/master/build/windows/native-gitlab-ci/siril-deps.sh bash siril-deps.sh ``` -------------------------------- ### Install Siril Dependencies (MSYS2) Source: https://siril.readthedocs.io/en/stable/_sources/installation/windows.rst.txt Download and execute the script to install all necessary dependencies for building Siril on Windows. This script fetches the latest version of dependencies. ```bash curl -s -o siril-deps.sh https://gitlab.com/free-astro/siril/-/raw/master/build/windows/native-gitlab-ci/siril-deps.sh bash siril-deps.sh ``` -------------------------------- ### Install Siril on Ubuntu/Linux Mint (Official Repos) Source: https://siril.readthedocs.io/en/stable/_sources/installation/linux.rst.txt Install Siril from the official repositories on Ubuntu or Linux Mint using apt. Note that this version might be outdated. ```bash sudo apt install siril ``` -------------------------------- ### Install Siril on Debian Source: https://siril.readthedocs.io/en/stable/_sources/installation/linux.rst.txt Install the Siril binary package on Debian using apt. This command requires superuser privileges. ```bash apt install siril ``` -------------------------------- ### Example Astro-TIFF Header (FITS-like) Source: https://siril.readthedocs.io/en/stable/file-formats/Astro-TIFF.html This example demonstrates the structure of an Astro-TIFF header, which closely resembles a standard FITS file header. It includes essential metadata for astronomical images. ```text SIMPLE = T / file does conform to FITS standard BITPIX = -32 / number of bits per data pixel NAXIS = 2 / number of data axes NAXIS1 = 6248 / length of data axis 1 NAXIS2 = 4176 / length of data axis 2 NAXIS3 = 1 / length of data axis 3 EXTEND = T / FITS dataset may contain extensions COMMENT FITS (Flexible Image Transport System) format is defined in 'Astronomy COMMENT and Astrophysics', volume 376, page 359; bibcode: 2001A&A...376..359H BZERO = 0 / offset data range to that of unsigned short BSCALE = 1 / default scaling factor DATE = '2022-12-14T16:05:47' / UTC date that FITS file was created DATE-OBS= '2022-05-06T20:29:20.019000' / YYYY-MM-DDThh:mm:ss observation start, INSTRUME= 'ZWO CCD ASI2600MM Pro' / instrument name OBSERVER= 'Unknown ' / observer name TELESCOP= 'iOptron ZEQ25' / telescope used to acquire this image ROWORDER= 'TOP-DOWN' / Order of the rows in image array XPIXSZ = 3.76 / X pixel size microns YPIXSZ = 3.76 / Y pixel size microns XBINNING= 1 / Camera binning mode YBINNING= 1 / Camera binning mode FOCALLEN= 370.092 / Camera focal length CCD-TEMP= -9.8 / CCD temp in C EXPTIME = 120 / Exposure time [s] STACKCNT= 126 / Stack frames LIVETIME= 15120 / Exposure time after deadtime correction FILTER = 'Lum ' / Active filter name IMAGETYP= 'Light Frame' / Type of image OBJECT = 'Unknown ' / Name of the object of interest GAIN = 100 / Camera gain OFFSET = 50 / Camera offset CTYPE1 = 'RA---TAN' / Coordinate type for the first axis CTYPE2 = 'DEC--TAN' / Coordinate type for the second axis CUNIT1 = 'deg ' / Unit of coordinates CUNIT2 = 'deg ' / Unit of coordinates EQUINOX = 2000 / Equatorial equinox OBJCTRA = '09 39 54.932' / Image center Right Ascension (hms) OBJCTDEC= '+70 00 10.118' / Image center Declination (dms) RA = 144.979 / Image center Right Ascension (deg) DEC = 70.0028 / Image center Declination (deg) CRPIX1 = 3123.5 / Axis1 reference pixel CRPIX2 = 2088.5 / Axis2 reference pixel CRVAL1 = 144.979 / Axis1 reference value (deg) CRVAL2 = 70.0028 / Axis2 reference value (deg) CD1_1 = -0.000580606 / Scale matrix (1, 1) CD1_2 = -4.12215e-05 / Scale matrix (1, 2) CD2_1 = -4.11673e-05 / Scale matrix (2, 1) CD2_2 = 0.000580681 / Scale matrix (2, 2) PLTSOLVD= T / Siril internal solve HISTORY Background extraction (Correction: Subtraction) HISTORY Plate Solve END ``` -------------------------------- ### Quick Photometry Result Example (Moffat Fit) Source: https://siril.readthedocs.io/en/stable/_sources/photometry/quickphotometry.rst.txt Example output snippet for Siril's quick photometry when the Moffat fitting function is used. This includes the beta parameter specific to the Moffat model. ```text PSF fit Result (Moffat, beta=2.9, monochrome channel): ``` -------------------------------- ### Set up Build Directory with Meson Source: https://siril.readthedocs.io/en/stable/_sources/installation/source.rst.txt Initializes the build environment using Meson for a release build. Ensure you are in the Siril source directory before running. ```bash meson setup _build --buildtype release ``` -------------------------------- ### Generate Build System and Compile Siril Source: https://siril.readthedocs.io/en/stable/installation/windows.html Set up the Meson build system and compile the Siril code. This command builds the release version and installs it. ```bash meson setup _build --buildtype release ninja -C _build install ``` -------------------------------- ### Initialize Live Stacking Source: https://siril.readthedocs.io/en/stable/Commands.html Starts a live stacking session, optionally using dark and flat calibration files. Supports shift-only registration by default, with options for rotation and 32-bit processing. Note: Siril is unresponsive to other commands during live stacking. ```bash start_ls [-dark=filename] [-flat=filename] [-rotate] [-32bits] ``` -------------------------------- ### Get PyTorch Device Source: https://siril.readthedocs.io/en/stable/Python-API.html Obtains a suitable torch device ('cuda', 'cpu', etc.) based on the installed PyTorch package's capabilities. Defaults to using GPU if available. ```python import torch from sirilpy.gpuhelper import TorchHelper torch_helper = TorchHelper() # Get the appropriate torch device, using GPU if available device = torch_helper.get_torch_device(use_gpu=True) print(f"Using PyTorch device: {device}") # Example of using the device # tensor = torch.randn(3, 3).to(device) ``` -------------------------------- ### Launch Siril from Windows Environment Source: https://siril.readthedocs.io/en/stable/installation/windows.html Launch Siril from a native Windows environment, either via the command line or by double-clicking the executable. This is required for the initial setup of the sirilpy module if Python is installed on the system. ```bash C:\msys2\ucrt64\bin\siril.exe ``` -------------------------------- ### Apply Guided Filter (Siril Command Line) Source: https://siril.readthedocs.io/en/stable/_sources/processing/epf.rst.txt Applies the Guided filter to an image using the Siril command line. Specify the filter type (1 for bilateral, 2 for guided), diameter, spatial sigma, intensity sigma, and modulation. For guided filter, a guide image can be specified. ```bash epf 2 diameter sigma_spatial sigma_intensity modulation guide_image ``` -------------------------------- ### Build and Install Siril from Source on Windows Source: https://siril.readthedocs.io/en/stable/_sources/installation/windows.rst.txt Update pacman, pull submodules, configure with meson, and build/install with ninja. This sequence is used to build Siril from its source code. ```bash pacman -Syu cd siril git pull --recurse-submodules meson setup _build --reconfigure ninja -C _build && ninja -C _build install ``` -------------------------------- ### Install Siril via Flatpak Source: https://siril.readthedocs.io/en/stable/_sources/installation/linux.rst.txt Install the stable version of Siril using the Flatpak package manager. This command installs Siril from the Flathub repository. ```bash flatpak install flathub org.siril.Siril ``` -------------------------------- ### Start Livestacking Session (Command Line) Source: https://siril.readthedocs.io/en/stable/Livestack.html Initializes a livestacking session. Optional calibration files can be provided. Default processing uses shift-only registration and 16-bit processing for speed, which can be changed with -rotate and -32bits. ```bash start_ls [-dark=filename] [-flat=filename] [-rotate] [-32bits] ``` -------------------------------- ### Start Livestacking Session (Command Line) Source: https://siril.readthedocs.io/en/stable/_sources/Livestack.rst.txt Initiates a livestacking session. Darks and flats can be provided as arguments for real-time calibration. ```bash siril -f --start_ls "/path/to/your/images/" --darks "/path/to/darks/" --flats "/path/to/flats/" ``` -------------------------------- ### Check if ONNX Runtime is Installed Source: https://siril.readthedocs.io/en/stable/Python-API.html Verifies if any ONNX Runtime package is currently installed and usable. Returns a tuple indicating installation status and the package name. ```python from sirilpy.gpuhelper import is_onnxruntime_installed is_installed, package_name = is_onnxruntime_installed() print(f"ONNX Runtime installed: {is_installed}, Package: {package_name}") ``` -------------------------------- ### Constructing a master flat file path Source: https://siril.readthedocs.io/en/stable/_sources/Pathparsing.rst.txt Example of constructing a path to a master flat file using header information like instrument, telescope, and filter. ```text ~/astro/masters/flats/$INSTRUME:%s$_$TELESCOP:%s$/$FILTER:%s$/FLAT_bin$XBINNING:%d$.fit ``` -------------------------------- ### Ensure Python Package Installation Source: https://siril.readthedocs.io/en/stable/_sources/Python-API.rst.txt Use this method to ensure that necessary Python packages are installed for your script. It leverages pip to install packages if they are not already present. ```python sirilpy.ensure_installed() ``` -------------------------------- ### Import Sirilpy and Ensure Astropy Installation Source: https://siril.readthedocs.io/en/stable/scripts/Python-scripts.html Imports the 'sirilpy' module and then ensures 'astropy' is installed, aliasing it as 'ap'. This method automates installation for users without the module, with delays only on the first run. ```python import sirilpy as s s.ensure_installed("astropy") import astropy as ap ``` -------------------------------- ### FITS Header Example Source: https://siril.readthedocs.io/en/stable/_sources/Pathparsing.rst.txt A sample FITS header output, showing various keywords and their values, which can be used for path parsing. ```text SIMPLE = T / C# FITS BITPIX = 16 / NAXIS = 2 / Dimensionality NAXIS1 = 4144 / NAXIS2 = 2822 / BZERO = 32768 / EXTEND = T / Extensions are permitted IMAGETYP= 'LIGHT' / Type of exposure EXPOSURE= 120.0 / [s] Exposure duration DATE-OBS= '2022-01-24T01:03:34.729' / Time of observation (UTC) XBINNING= 1 / X axis binning factor YBINNING= 1 / Y axis binning factor GAIN = 120 / Sensor gain OFFSET = 30 / Sensor gain offset INSTRUME= 'ZWO ASI294MC Pro' / Imaging instrument name SET-TEMP= -10.0 / [degC] CCD temperature setpoint CCD-TEMP= -10.0 / [degC] CCD temperature BAYERPAT= 'RGGB' / Sensor Bayer pattern TELESCOP= '61EDPH' / Name of telescope FILTER = 'DualBand' / Active filter name OBJECT = 'Rosette Nebula '/ Name of the object of interest OBJCTRA = '06 30 36' / [H M S] RA of imaged object OBJCTDEC= '+04 58 51' / [D M S] Declination of imaged object RA = 97.6960081674312 / [deg] RA of telescope DEC = 4.99212765957446 / [deg] Declination of telescope END ``` -------------------------------- ### Ensure Python Packages are Installed Source: https://siril.readthedocs.io/en/stable/Python-API.html Use this method to programmatically ensure that necessary Python packages are installed for your Siril script. This is crucial as users may not have direct access to the command line to install them manually. ```python sirilpy.ensure_installed("numpy") sirilpy.ensure_installed("packaging") ``` -------------------------------- ### Make AppImage Executable Source: https://siril.readthedocs.io/en/stable/_sources/installation/linux.rst.txt Allow the downloaded Siril AppImage binary to be executed. Replace Path/To/Application/Siril-x.y.z-x86_64.AppImage with the actual path and version. ```bash chmod +x Path/To/Application/Siril-x.y.z-x86_64.AppImage ``` -------------------------------- ### start_ls Command Source: https://siril.readthedocs.io/en/stable/Commands.html Initializes a live stacking session, optionally using calibration files. It waits for input files from the LIVESTACK command until STOP_LS is called. ```APIDOC ## start_ls ### Description Initializes a livestacking session, using the optional calibration files and waits for input files to be provided by the LIVESTACK command until STOP_LS is called. Default processing will use shift-only registration and 16-bit processing because it's faster, it can be changed to rotation with -rotate and -32bits. ### Usage ``` start_ls [-dark=filename] [-flat=filename] [-rotate] [-32bits] ``` ### Options - **-dark=filename**: Specifies the dark calibration file. - **-flat=filename**: Specifies the flat calibration file. - **-rotate**: Enables rotation registration for live stacking. - **-32bits**: Enables 32-bit processing for live stacking. ``` -------------------------------- ### List All Siril Preferences Variables Source: https://siril.readthedocs.io/en/stable/_sources/preferences/preferences_command.rst.txt Use the 'get -A' command to display a list of all configurable variables in Siril, including their current values and descriptions. Use '-a' to omit descriptions. ```bash get -A ``` -------------------------------- ### Ensure Installation of Astropy Module Source: https://siril.readthedocs.io/en/stable/scripts/Python-scripts.html Use `ensure_installed()` to verify and install the 'astropy' module if it's not already present. This method attempts to import the module and installs it if the import fails. The delay only occurs on the first run. ```python s.ensure_installed("astropy") import astropy ``` -------------------------------- ### Verify Local Catalogue Installation with Conesearch Source: https://siril.readthedocs.io/en/stable/astrometry/platesolving.html Use the `conesearch` command with the `-phot` option to check which stars from your image will be used for Photometric Calibration (PCC) and are available in your installed catalogues. This is useful after installing local catalogues. ```bash conesearch -phot ``` -------------------------------- ### Specify Siril Configuration File Source: https://siril.readthedocs.io/en/stable/Preferences.html Use this command to start Siril with a specific configuration file, allowing for multiple independent settings profiles. ```bash siril -i path/to/my_other_config.ini ``` -------------------------------- ### Siril FITS Header Example Source: https://siril.readthedocs.io/en/stable/Pathparsing.html A sample FITS header dump showing various keys and their values, such as IMAGETYP, EXPOSURE, DATE-OBS, GAIN, and SET-TEMP. These keys can be used in path parsing. ```text SIMPLE = T / C# FITS BITPIX = 16 / NAXIS = 2 / NAXIS1 = 4144 / NAXIS2 = 2822 / BZERO = 32768 / EXTEND = T / Extensions are permitted IMAGETYP= 'LIGHT' / Type of exposure EXPOSURE= 120.0 / [s] Exposure duration DATE-OBS= '2022-01-24T01:03:34.729' / Time of observation (UTC) XBINNING= 1 / X axis binning factor YBINNING= 1 / Y axis binning factor GAIN = 120 / Sensor gain OFFSET = 30 / Sensor gain offset INSTRUME= 'ZWO ASI294MC Pro' / Imaging instrument name SET-TEMP= -10.0 / [degC] CCD temperature setpoint CCD-TEMP= -10.0 / [degC] CCD temperature BAYERPAT= 'RGGB' / Sensor Bayer pattern TELESCOP= '61EDPH' / Name of telescope FILTER = 'DualBand' / Active filter name OBJECT = 'Rosette Nebula '/ Name of the object of interest OBJCTRA = '06 30 36' / [H M S] RA of imaged object OBJCTDEC= '+04 58 51' / [D M S] Declination of imaged object RA = 97.6960081674312 / [deg] RA of telescope DEC = 4.99212765957446 / [deg] Declination of telescope END ``` -------------------------------- ### Ensure PyTorch Installation Source: https://siril.readthedocs.io/en/stable/Python-API.html Ensures PyTorch is installed with the correct backend. Allows specifying a CUDA version to override auto-detection. ```python from sirilpy.gpuhelper import TorchHelper torch_helper = TorchHelper() # Ensure PyTorch is installed, optionally specifying CUDA version success = torch_helper.ensure_torch(cuda_version='cu118') print(f"PyTorch ensured: {success}") ``` -------------------------------- ### Install Siril Dependencies on Arch Linux Source: https://siril.readthedocs.io/en/stable/_sources/installation/source.rst.txt Installs mandatory and some optional dependencies for Siril on Arch Linux using pacman. ```bash pacman -S base-devel cmake git intltool gtk3 fftw cfitsio gsl opencv exiv2 libraw wcslib gtksourceview4 ``` -------------------------------- ### Build Siril with Meson Source: https://siril.readthedocs.io/en/stable/installation/source.html Use Meson and Ninja for building Siril. This is the recommended approach. Ensure you are in the source directory before running these commands. ```bash meson setup _build --buildtype release cd _build ninja ninja install ``` -------------------------------- ### Install Siril Build Dependencies on Debian Source: https://siril.readthedocs.io/en/stable/_sources/installation/source.rst.txt Installs packages required for building Siril on Debian-based systems using apt. ```bash apt build-dep siril ``` -------------------------------- ### Siril Command Line: Capabilities Source: https://siril.readthedocs.io/en/stable/_sources/Installation.rst.txt This snippet shows how to use the 'capabilities' command in Siril to check your installation. It is included within the Siril command line admonition. ```bash siril --capabilities ``` -------------------------------- ### Example of Generated Filename Source: https://siril.readthedocs.io/en/stable/Pathparsing.html This is an example of how a stacked image file would be named when using the $defstack format defined previously. ```text Result_Rosette_Nebula_2022-01-24_12000s.fit ``` -------------------------------- ### 2-Pass Registration and Application Source: https://siril.readthedocs.io/en/stable/_sources/preprocessing/registration.rst.txt Performs a two-pass registration on a sequence and then applies the calculated transformations. The output sequence is named 'pp_light'. ```text # Align lights in 2 passes register pp_light -2pass seqapplyreg pp_light ``` -------------------------------- ### Check if JAX is Installed Source: https://siril.readthedocs.io/en/stable/Python-API.html Verifies if JAX is installed without attempting to import it. This is a quick check to determine JAX's presence. ```python sirilpy.gpuhelper.JaxHelper().is_jax_installed() ``` -------------------------------- ### Check if PyTorch is Installed Source: https://siril.readthedocs.io/en/stable/Python-API.html Checks if PyTorch is installed without actually importing the library. This is useful for conditional logic before attempting to use PyTorch. ```python from sirilpy.gpuhelper import TorchHelper torch_helper = TorchHelper() is_installed = torch_helper.is_torch_installed() print(f"PyTorch is installed: {is_installed}") ```