Blame view

README.md 3.43 KB
96482ab2   Alain Klotz   first commit
1
2
3
4
5
6
# Guitastro library

GUITAstro stands for General Use of Instruments and Telescopes in ASTROnomy.

GuitAstro is a Python module that provides classes and methods to write easily Python scripts for astronomical observations. 

53cb6146   Alain Klotz   Modifs README.md
7
[GIT repository: https://gitlab.irap.omp.eu/guitastrolib/guitastro.git](https://gitlab.irap.omp.eu/guitastrolib/guitastro.git)
96482ab2   Alain Klotz   first commit
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

## Few basic examples of use

First example: Subtract a dark file dark.fit to a raw image messier63.fit and save the image m63.fits:
```
import guitastro
ima = guitastro.Ima()
ima.load("messier63.fit")
ima.sub("dark.fit")
ima.save("m63.fits")
```
Second example: Subtract a dark file dark.fit to a series of raw images messier63-1.fit to messier63-25.fit and save the images m63-1.fit to m63-25.fit:
```
import guitastro
imaseries = guitastro.ImaSeries()
imaseries.path("obs/my_raw_images")
imaseries.extension(".fit")
imaseries.sub("messier63-1.fit", "m63-", "dark.fit")
```
Guitastro will collect all the file names corresponding to messier63-*.fit before subtracting dark.fit to these files.

## How to install Guitastro?

```
git config --global http.sslVerify false	
53cb6146   Alain Klotz   Modifs README.md
33
git clone https://gitlab.irap.omp.eu/guitastrolib/guitastro.git
96482ab2   Alain Klotz   first commit
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
cd guitastro
python setup.py install
```

This install allow to import guitastro in any Python program.
For Guitastro developers read the documentation in the guitastro/docs folder for details.

## Guitastro functionalities

GuitAstro wraps the classical astronomical Python modules (AstroPy, etc.) and adds functionalities. They are dispatched into classes.

### Classes for image processing and analysis

- **Ima**: Manage one image. Load and save, processing, analysing. 
- **ImaSeries**: Manage a series of images applying the same processing to all images of the series. 
- **ImaStack**: Manage a series of images apply a processing to generate one output image. 
- **Visu**: Provides a graphical tool to display images.

### Classe for camera acquisitions

- **Camera**: Manage camera drivers. This class provides a simulated camera.
Additional classes can be added to Guitastro for specific drivers (ASCOM, INDI, Balser).

### Classes for angle conversions

- **Angle**: Manage angle formats and computations.
- **Coords**: Manage coordinates, spherical, cartesian.

### Classes for date conversions

- **Date**: Manage date formats and computations.
- **Durations**: Manage durations and computation with dates.

### Classes for ephemeris computation

- **Ephemeris**: Compute ephemeris of planets, minor planets, comets, artificial satellites. 
- **Mechanics**: Manage celestial mechanics.
- **Targets**: Manage old style ephemeris.
- **ExposureTimeCalculator**: Compute exposure time from an instrumental setup.
- **Voevent**: Manage clients for receiving VOEvents

### Classes for earth location definitions

- **Home**: Manage earth geographical coordinates formats.
- **Horizon**: Manage a local horizon line to define a site.
- **Site**: Manage geagraphical site defined by home, horizon and atmosphere.

### Classe to generate various maps

- **Maps**: Generation of earth or sky maps.

A complete documentation can be generated from .rst files in the folder doc/doc_rst

## History

GuitAstro is inspired by the software AudeLA written since 1999 by astronomers of the Toulouse region (France).

Why the name GuitAstro ?

- Official version: General Use of Instruments and Telescopes in ASTROnomy.
- Legendary version: GUITalens ASTROnomy

## Support and contact

The main author is alain.klotz@irap.omp.eu