source: fact/tools/pyscripts/doc/getting_started.rst@ 13316

Last change on this file since 13316 was 13316, checked in by lusterma, 13 years ago
worked on doc
File size: 2.7 KB
Line 
1===============
2Getting Started
3===============
4
51) Get an account at the FACT data center at ISDC
62) Setup your environment variables
73) Checkout the pyfact software repository
84) Try a few examples
9
101. Important links
11=================================
12
13**FACT data center at ISDC** <http://www.isdc.unige.ch/fact/datacenter>**
14 here you find instructions how to get an account, how to set it up and how to use it
15
16**SVN repository** <https://fact.isdc.unige.ch/svn/fact/>
17 hosts all FACT software (including pyfact)
18
19**FACT run database** <https://www.fact-project.org/run_db/db/fact_runinfo.php>
20 here you find information about all available runs
21
22**eLogbook** <https://www.fact-project.org/logbook/>
23 telescope logbook used since Dec. 1, 2012; for logbook information before this date have a look here: <http://fact.ethz.ch/FACTelog/index.jsp>
24
25**FACT La Palma pages** <https://www.fact-project.org/>
26 plenty of information concerning the telescope in La Palma
27
282. Environment variables
29=====================
30set the following env variables depending on the SHELL you are using, for instance in .bashrc or .tcshrc
31
32* **ROOTSYS**: /swdev_nfs/root_v5.28.00
33* **PATH**: add $ROOTSYS/bin
34* **PATH**: add /swdev_nfs/FACT++
35* **LD_LIBRARY_PATH**: $ROOTSYS/lib:/swdev_nfs/FACT++/.libs
36* **PYTHONPATH**: $ROOTSYS/lib
37* **PYTHONPATH**: add all directories where python should search for modules. At least:
38 * pyscripts/pyfact
39 * pyscript/tools
40 * pyscripts/ecamples
41 * py
42
43the absolute path depends on where you have checked (or will check) out the pyscripts repository
44
453. Check out the repository
46========================
47svn co https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/
48
494. Create pyfits library
50========================
51FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the default tool:
52
53`pyfits <http://www.stsci.edu/institute/software_hardware/pyfits>`.
54
55To mitigate this problem a C++ class defined in `fits.h` is used. A simple possibility to create an interface of this C++ class and python is to use the
56
57`pyroot http://root.cern.ch/drupal/category/package-context/pyroot>` module.
58
59simple::
60
61 [pceth118] /home/luster/py > root
62 ROOT 5.28/00h (branches/v5-28-00-patches@42209, Feb 13 2012, 23:52:00 on linux)
63 CINT/ROOT C/C++ Interpreter version 5.18.00, July 2, 2010
64 Type ? for help. Commands must be C++ statements.
65 Enclose multiple statements between { }.
66 root [0] .L fits.h++
67 Info in <TUnixSystem::ACLiC>: creating shared library /home/luster/py/./fits_h.so
68 root [1]
69
70
71
725. Run examples
73============
74
75
76=======
77Classes
78=======
79
80pyfact.py
81=========
82
83rawdata access
84-------
85.. autoclass:: pyfact.RawData
86 :members:
87
88
89fnames of a data run
90--------------------
91.. autoclass:: pyfact.fnames
92 :members:
93
94
Note: See TracBrowser for help on using the repository browser.