guitastrolib / guitastro_device_deltatau

Blame view

docs/source/index.rst 2.01 KB
Edit Raw Normal View History
527116ca   Alain Klotz   first commit 
1
2
3
4
5
6
7
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
33
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
 
*************************************************************
Welcome in the GuitAstro Device DeltaTau module documentation
*************************************************************

1. What is GuitAstro Device DeltaTau?
*************************************

GuitAstro is a Python module that provides classes and methods
to write scripts for astronomical observations. GuitAstro wraps 
the classical astronomical Python modules (AstroPy, etc.) and
adds functionalities.

All information are provided in the Git repository `https://gitlab.irap.omp.eu/aklotz/guitastro.git <https://gitlab.irap.omp.eu/aklotz/guitastro.git>`_.

GuitAstro Device DeltaTau is a complement of GuitAstro to add
the class device_deltatau. By this way, it is possible to
use mount, filter wheel and focuser driven by DeltaTau.

`DeltaTau <http://www.observatorysciences.co.uk/deltatau.php/>`_ provides a motion controler between application
(as GuitAstro) to drive telescope motors.

.. figure:: doc_images/deltatau1.jpg
	:height: 100px
	:align: center

	DeltaTau Logo.

2. Installation of Guitastro Device DeltaTau
*********************************************

See the documentation of `GuitAstro <https://gitlab.irap.omp.eu/aklotz/guitastro.git>`_.
The principles are exactly the same. The main folder guitastro_device_deltatau must lie at
the same tree level than guitastro as shown below:

.. code-block:: bash
		
	guitastro_packages/
	|---guitastro/
	|    ...
	|---guitastro_device_deltatau/
	|   ...
		
3. External resources
*********************

No external source is needed.

4. Some very simple tests
*************************

.. toctree:: 
   :maxdepth: 3

   guitastro_simple_examples

5. Example collection
*********************

.. toctree:: 
   :maxdepth: 3

   guitastro_examples

6. Class and method documentation
***********************************

For developers of Python code of GuitAstro:

.. toctree:: 
   :maxdepth: 3

   generate_documentation
	
The classes of GuitAstro Devices DeltaTau.
	 
.. toctree:: 
   :maxdepth: 3

   autodoc_guitastro