=======================
Developer Documentation
=======================


Code organization
=================

Directories relative to the root of the source tree
:wq

+----------------+--------------------------------------------+
| directory      | content                                    |
+================+============================================+
| :file:`src/`   | Contains all code and run scripts          |
+----------------+--------------------------------------------+
| :file:`doc/`   | documentation                              |
+----------------+--------------------------------------------+
| :file:`test/`  | unit tests and software acceptance tests   |
+----------------+--------------------------------------------+

Run scripts
===========

The run scripts for the individual programs are found below
:file:`nexus_image_tools`

+------------------------+-------------------------+
| script name            |  purpose                |
+========================+=========================+
| :file:`qnx2img_exe.py` |  runs :program:`qnx2img`| 
+------------------------+-------------------------+
| :file:`img2nx_exe.py`  |  runs :program:`img2nx` | 
+------------------------+-------------------------+
| :file:`nx2img_exe.py`  |  runs :program:`nx2img` |
+------------------------+-------------------------+

Intended installation of the package
====================================

At the current state the `nexus image tools` are not intended to be used as an
independent Python package to be used by other programs. Thus, the package 
should not be installed like a normal Python package. Instead, I suggest an
installation scheme as proposed by the Debian Python policy.

The :file:`nexus_image_tools` directory from the :file:`src` should typically
to to :file:`/usr/share`. Within :file:`nexus_image_tools` three scripts are
located which run the actual programs. Symbolic links to this scripts 
with appropriate name should be provided at a location in the `PATH` 
of the users.

+--------------------------+--------------------------+
| link                     |  target                  |
+==========================+==========================+
| :file:`/usr/bin/qnx2img` |  :file:`qnx2img_exe.py`  |
+--------------------------+--------------------------+
| :file:`/usr/bin/img2nx`  |  :file:`img2nx_exe.py`   |
+--------------------------+--------------------------+
| :file:`/usr/bin/nx2img`  |  :file:`nx2img_exe.py`   |
+--------------------------+--------------------------+


.. toctree::
   :maxdepth: 1
 
   release_checklists
   documentation
   common_code
   nx2img_code
   img2nx_code
   qnx2img_code