======Documentation index======

===== Tutorial =====
Start by this tutorial to quickly get an idea how the program work.

  * [[The program screen]]
  * [[Connecting the equipment]]
  * [[Global configuration]]
  * [[Focusing]]
  * [[Simple capture]]
  * [[Plate solving]]
  * [[Automated sequence]]
  * [[Video tutorial]]
  * [[FAQ]]

===== Reference Manual =====
This give detailed information on every program aspect. The pages follow the order of the main menu.

  * [[File|Menu File]] 
  * [[Edit|Menu Edit]] with the devices and preferences setting
  * [[Tools|Menu Tools]]
  * [[right_click_menu|Menu Image]] same as the image right click menu
  * [[display|Menu Display]] to show the different tool box
  * [[Help|Menu Help]]
  * [[Status bar]]
  * [[CCDciel status]] web page.
  * [[ccdscript|Scripting]]
  * [[jsonrpc_reference|JSON-RPC interface]] for Python and other software.
  * [[script_reference|Pascal interface]] for Pascal scripting.
  * [[cmdline|Command line options]]
  * [[Image preprocessing]]

===== Installation =====

To install the software look at the page corresponding to your computer.

  * [[Installation on Ubuntu|Installation on Ubuntu, Debian]]
  * [[Installation on Linux]]
  * [[Installation on Windows]]
  * [[Installation on Mac OS X|Installation on macOS]]
  * [[Hyperleda database|Installation of Hyperleda database]] (all computer)
  * [[Compilation]] of the source code

<WRAP pagebreak />
==== External dependencies ====
You must install this softwares to take full advantage of CCDciel, at least one in each category:

  ***Equipment driver**
    * [[ASCOM]] or [[INDI]]
  ***Plate solving**
    * [[ASTAP]]
    * [[Astrometry.net]] 
    * [[Star Locator Elbrus]]
    * [[PlateSolve 2]]
  ***Auto-guider**
    * [[https://openphdguiding.org/|PHD2]] or [[https://sourceforge.net/projects/linguider/|Lin_guider]]
  ***Planetarium**
    * [[https://www.ap-i.net/skychart/fr/start|Cartes du Ciel]]
    * [[http://www.hnsky.org/software.htm|Hallo Northern SKY]], need a version more recent than 4.1.5
  ***Image preprocessing**
    * [[https://www.siril.org|Siril]]
  ***Python scripting** 
    * [[Install Python]] for extended scripting capabilities
 

===== Credit =====

==== Tools ====
CCDciel make use of the following development tools:
  * [[https://www.freepascal.org/|Free Pascal]] compiler
  * [[http://www.lazarus-ide.org|Lazarus]] IDE and library
  * [[http://wiki.freepascal.org/BGRABitmap|BGRABitmap]] component
  * [[https://www.ararat.cz/synapse|Synapse]] library
  * [[http://tdc-www.harvard.edu/wcstools/|WCSTools]] library
  * [[https://www.libraw.org/|LibRaw]] library

==== Developer ====
  * Patrick Chevalley
  * Han Kleijn

The source code is available from [[https://github.com/pchev/ccdciel|GitHub]]

===== License =====

  Copyright (C) 2015-2025 Patrick Chevalley, http://www.ap-i.net/ccdciel
    
  This program is free software; you can redistribute it and/or modify it under 
  the terms of the GNU General Public License as published by the Free Software 
  Foundation; either version 3 of the License, or (at your option) any later version.
  
https://www.gnu.org/licenses/gpl.html