README (Revision 4452, commited at 2011-03-16)

Go to the documentation of this file.
00001 =====
00002 PyDIM
00003 =====
00004 
00005 PyDIM is a Python interface to DIM. PyDIM could be used to create DIM clients 
00006 and servers, using an API very similar to the one that is used for C.
00007 
00008 Check the online documentation at:
00009 
00010     http://lbdoc.cern.ch/pydim/
00011 
00012 
00013 Installation
00014 ============
00015 
00016 PyDIM can be installed using the setup.py script:: 
00017 
00018     $ python setup.py install
00019 
00020 If you need additional instructions please see the file `doc/guide/install.txt`.
00021 
00022 
00023 Hacking
00024 =======
00025 
00026 Here are some guidelines that may help if you want to modify or just read the
00027 code of pydim.
00028 
00029 Directory structure
00030 -------------------
00031 
00032 src:
00033     The part of the extension written in C++
00034 doc:
00035     Documentation
00036 examples:
00037     Examples for how to write servers and clients with PyDIM
00038 pydim:
00039     Additional functions included in the extension, written in Python.
00040 setup:
00041     An old setup script. It should be deprecated.
00042 test:
00043     Unit tests. They can be used as a reference.
00044     
00045 The following files are included in the root directory:
00046 
00047 INSTALL: 
00048     Instructions for installing and building the RPM
00049 
00050 MANIFEST.in: 
00051     A template for the Manifest file used with `distutils`.
00052 
00053 setup.cfg: 
00054     Additional configuration for the `distutils` script.
00055     
00056 setup.py: 
00057     Installation script
00058      
00059 TODO: 
00060     List of current tasks.
00061     
00062 VERSION: 
00063     Version number of the package. It's used in the build process.
00064 
00065 
00066 Contact
00067 -------
00068 
00069 This module was originally developed by Radu Stoica based on code by Niko Neufeld.
00070 Juan Manuel Caicedo improved it significantly and fixed many bugs.
00071 
00072 It is currently maintained by Niko Neufeld (niko.neufeld@cern.ch)
00073 
00074 Feel free to send your questions and bug reports.

Generated on 5 Feb 2014 for PyDIM by  doxygen 1.4.7