"Fossies" - the Fresh Open Source Software Archive

Member "relax-4.1.3/docs/devel/package_layout" (18 Apr 2019, 4038 Bytes) of package /linux/privat/relax-4.1.3.src.tar.bz2:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "package_layout": 4.0.3_vs_4.1.0.

    1 ###############################################################################
    2 #                                                                             #
    3 # Copyright (C) 2013-2014 Edward d'Auvergne                                   #
    4 #                                                                             #
    5 # This file is part of the program relax (http://www.nmr-relax.com).          #
    6 #                                                                             #
    7 # This program is free software: you can redistribute it and/or modify        #
    8 # it under the terms of the GNU General Public License as published by        #
    9 # the Free Software Foundation, either version 3 of the License, or           #
   10 # (at your option) any later version.                                         #
   11 #                                                                             #
   12 # This program is distributed in the hope that it will be useful,             #
   13 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
   14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
   15 # GNU General Public License for more details.                                #
   16 #                                                                             #
   17 # You should have received a copy of the GNU General Public License           #
   18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
   19 #                                                                             #
   20 ###############################################################################
   21 
   22 
   23 Directory layout design (2013-03-01)
   24 ====================================
   25 
   26 The following is an idea for how to lay out the directories for the relax sources.  The changes suggested must occur after the merging of the frame_order_testing branch.
   27 
   28 ____________________________________________________________________________________________________
   29 
   30 Package             Description
   31 ____________________________________________________________________________________________________
   32 
   33 auto_analyses       Unchanged from now.  A collection of massive relax scripts used to simplify the
   34                     life of relax users.
   35 
   36 data_store          The relax data store and all modules which operate on it (data and generic_fns).
   37 
   38 extern              GPL compatible packages bundled with relax.
   39 
   40 graphics            Mainly a repository for all bitmap and vector graphics, but a few auxiliary
   41                     functions for handling graphics within relax (e.g. icons in the GUI).
   42 
   43 gui                 The graphical UI.
   44 
   45 lib                 A set of modules and functions independent of the relax data store and specific
   46                     analyses.  Half of maths_fns and some of generic_fns.  No code is allowed to
   47                     reference the data store!
   48 
   49 lib.frame_order     Most of the modules of maths_fns.frame_order.
   50 
   51 lib.geometry        To include, for example, maths_fns.rotation_matrix.
   52 
   53 lib.opendx          From opendx.
   54 
   55 lib.alignment       For example maths_fns.rdc, math_fns.pcs, etc.
   56 
   57 lib.structure       From generic_fns.structure.
   58 
   59 multi               The multi-processor code.
   60 
   61 pipe_control        All modules which are used to manage data in the relax data pipes.  This is most of generic_fns.
   62 
   63 prompt              The prompt/script UI.
   64 
   65 scons               The SCons modules.
   66 
   67 specific_analyses   Analysis specific code (currently called specific_fns).
   68 
   69 target_functions    A collection of all the target functions.  This is most of the current
   70                     maths_fns.  The modules contain target function classes which must present the
   71                     func() method as the target function (and the optional dfunc() and d2func() for
   72                     the gradient and Hessian respectively).
   73 
   74 test_suite          The relax test suite.
   75 
   76 user_functions      The definitions of the relax user functions.
   77 ____________________________________________________________________________________________________