Changeset 13316 for fact/tools/pyscripts/doc/_build/html/_sources

Timestamp:

04/05/12 14:10:40 (13 years ago)

Author:

lusterma

Message:

worked on doc

Location:

fact/tools/pyscripts/doc/_build/html/_sources

Files:

• classes.txt (modified) (1 diff)
• getting_started.txt (modified) (2 diffs)
• index.txt (modified) (1 diff)
• introduction.txt (modified) (1 diff)

fact/tools/pyscripts/doc/_build/html/_sources/classes.txt

@@ -18 +18 @@
 
 FIR filter functions
---------------------
+=====================
 .. autoclass:: fir_filter
         :members:

fact/tools/pyscripts/doc/_build/html/_sources/getting_started.txt

@@ +1 @@
+===============
+Getting Started
+===============
+
+1) Get an account at the FACT data center at ISDC
+2) Setup your environment variables
+3) Checkout the pyfact software repository
+4) Try a few examples
+
+1. Important links
+=================================
+
+**FACT data center at ISDC** <http://www.isdc.unige.ch/fact/datacenter>**
+    here you find instructions how to get an account, how to set it up and how to use it
+
+**SVN repository** <https://fact.isdc.unige.ch/svn/fact/>
+    hosts all FACT software (including pyfact)
+
+**FACT run database** <https://www.fact-project.org/run_db/db/fact_runinfo.php>
+    here you find information about all available runs
+
+**eLogbook** <https://www.fact-project.org/logbook/>
+  telescope logbook used since Dec. 1, 2012; for logbook information before this date have a look here: <http://fact.ethz.ch/FACTelog/index.jsp>
+
+**FACT La Palma pages** <https://www.fact-project.org/>
+  plenty of information concerning the telescope in La Palma
+
+2. Environment variables
+=====================
+set the following env variables depending on the SHELL you are using, for instance in .bashrc or .tcshrc
+
+* **ROOTSYS**: /swdev_nfs/root_v5.28.00
+* **PATH**: add $ROOTSYS/bin
+* **PATH**: add /swdev_nfs/FACT++
+* **LD_LIBRARY_PATH**: $ROOTSYS/lib:/swdev_nfs/FACT++/.libs
+* **PYTHONPATH**: $ROOTSYS/lib
+* **PYTHONPATH**: add all directories where python should search for modules. At least:
+    * pyscripts/pyfact
+    * pyscript/tools
+    * pyscripts/ecamples
+    * py
+
+the absolute path depends on where you have checked (or will check) out the pyscripts repository
+
+3. Check out the repository
+========================
+svn co https://fact.isdc.unige.ch/svn/fact/tools/pyscripts/
+
+4. Create pyfits library
+========================
+FACT data are stored in (gzipped) fits files, but the data files are too large to be read by the default tool: 
+
+`pyfits <http://www.stsci.edu/institute/software_hardware/pyfits>`.
+
+To 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 
+
+`pyroot http://root.cern.ch/drupal/category/package-context/pyroot>` module.
+
+simple::
+
+  [pceth118] /home/luster/py > root
+  ROOT 5.28/00h (branches/v5-28-00-patches@42209, Feb 13 2012, 23:52:00 on linux)
+  CINT/ROOT C/C++ Interpreter version 5.18.00, July 2, 2010
+  Type ? for help. Commands must be C++ statements.
+  Enclose multiple statements between { }.
+  root [0] .L fits.h++
+  Info in <TUnixSystem::ACLiC>: creating shared library /home/luster/py/./fits_h.so
+  root [1]
+
+
+
+5. Run examples
+============
+
+
 =======
 Classes
@@ -8 +83 @@
 rawdata access
 -------
-.. autoclass:: pyfact.rawdata
+.. autoclass:: pyfact.RawData
     :members:
 

fact/tools/pyscripts/doc/_build/html/_sources/index.txt

@@ -13 +13 @@
 
    introduction
+   getting_started
    classes
    examples

fact/tools/pyscripts/doc/_build/html/_sources/introduction.txt

@@ -9 +9 @@
 * examples
 
-The code of pyfact follows the `Style Guide for python code <http://www.python.org/dev/peps/pep-0008/>_.
+If you are new to python you need to learn the basics. In any case it would be wise to study the following book:
+
+*A Primer on Scientific Programming with Python - Hans Petter Langtangen* 
+
+pyfact is supposed to follow closely the programming style thought in this book.
+
+`python documentation pages <http://docs.python.org/>`_
+
+`astropython.org <http://www.astropython.org/resources>`_
+
+Python version and modules used
+-------------------------------
+As long as you work on the ISDC FACT cluster most things should be just fine. 
+|python version: 2.6.6
+|--- add later: list of modules
+
+Style guide and coding conventions
+----------------------------------
+The code of pyfact follows the `Style Guide for python code <http://www.python.org/dev/peps/pep-0008/>.