********* WHAT IS ? ********* "MODNUM" is a toolbox for the modelling and the simulation of communication systems. This toolbox proposes blocks, schematics and in-line functions of base-band PSK/QAM modulations in order to build communication chains. Components used to build spread-spectrum communication systems, such Pseudo Noise sequence generators (Quasi-Chaotic, PN and Gold sequence generators) are also included as well as some miscellaneous scopes for scicos (spectrum analyzer, eye diagram Scope, scattered diagram scope,...). Schematics and blocks of integer and fractionnal frequency synthesizer components (Phase/Frequency Detector, VCO, Delta-Sigma modulators and others) and are provided. This toolbox also focus on the simulation of chaotic systems and gives schematics of Chua's, Rössler's, Van-der Pol's systems (and others). ******* INSTALL ******* For the Scilab functions, you need ScicosLab or Nsp. For the Scicos blocksets, you need Scicos. Windows platform ---------------- - Binary version - Run the loader.sce script file provided in the root directory of the toolbox in a ScicosLab or Nsp session. If you have a writting access to the ScicosLab or Nsp directory, you can install the toolbox in the contrib directory for ScicosLab and in the toolboxes directory for Nsp to load Modnum from the Toolboxes menu. - Source version (MSVC and LCC-Win32 are supported) - (No fortran compiler supported at this time) 1 - Run the builder.sce script file provided in the root directory of the toolbox in a ScicosLab session or run the builder_nsp.sce script file for Nsp. 2 - To reload the toolbox, simply run the loader.sce script file provided in the root directory of the toolbox in a ScicosLab or Nsp session. RMK : * If you don't have a MSVC compiler, you can use LCC-WIN32 (for non-commercial use) and put it into the directory of ScicosLab. (see : ScicosLab-x.x\lcc\Readme_LCC.txt). * LCC-WIN32 is not supported in Nsp. * Building the toolbox inside Nsp under windows platform with MSVC compiler requires additional files like gtk headers and fttw. Current binary package of Modnum for Nsp is build with the source package and with a MINGW32 cross compiler chain. This is done under linux platform using the top configure script (see below for more details) with something like : ./configure --host=i686-pc-mingw32 --with-nspsrc=nspdir_cross where nspdir_cross is the path of a cross-compiled Nsp. * On windows platform : - Fortran routines are not compiled. - Documentation isn't build. Unix/Linux platform ------------------- - Source version (gcc is supported) - Method A : Construction in ScicosLab/Nsp 1 - Run the builder.sce script file provided in the root directory of the toolbox in a ScicosLab session. or Run the builder_nsp.sce script file for Nsp. 2 - To reload the toolbox, simply run the loader.sce script file provided in the root directory of the toolbox in a ScicosLab or Nsp session or go to the root directory of the toolbox and launch ScicosLab from a terminal prompt (that method is not supported for Nsp). Method B : Construction with Makefile 1 - Go to the root directory of the toolbox and run the configure script : ./configure --with-scisrc=scicoslabdir --with-gtk2 or for nsp : ./configure --with-nspsrc=nspdir You must have ScicosLab or Nsp. The path scicoslabdir or nspdir are typically /usr/lib/scicoslab-gtk-4.4.1 or /usr/lib/nsp. Then run 'make all' at the root directory. 2 - To reload the toolbox, simply run the loader.sce script file provided in the root directory of the toolbox in a ScicosLab/Nsp session or go to the root directory of the toolbox and launch ScicosLab from a terminal prompt (that method is not supported for Nsp). - Binary version - Run the loader.sce script file provided in the root directory of the toolbox in a ScicosLab/Nsp session or go in the root directory of the toolbox and launch ScicosLab from the terminal prompt (that method is not supported for Nsp). ************* DOCUMENTATION ************* - The source version and the binary version of this toolbox should include a html format documentation. Main index of this documentation is available by the "whatis.htm" file in the directories MODNUM/interf/scicos/help for Scicos and MODNUM/interf/scicoslab/help for Scicoslab. - Two languages are supported : english and french. **************** TOOLBOX CONTENTS **************** ./src : low-level computational routines of "modnumlib" ./interf : interfacing functions directory ./interf/nsp : interfacing functions for nsp demos : demonstrations of nsp gateway : interfacing functions of nsp ./inter/octave : interfacing functions for octave ./interf/scicos : interfacing functions for scicos demos : demonstrations of scicos examples : examples of scicos scs_diagr : directory of scicos diagrams comsys : diagrams of communication systems dyna : diagrams of non-Linear chaotic systems pll : diagrams of frequency synthesizer and PLL simu : directory of simulations of communication systems gif_icons : directory of gif icons of scicos blocks help : directory of man pages of scicos macros : directory of scilab macros build_util : macros used for the building of the toolbox pll : pll macros scicos_blocks : interfacing functions of Scicos blocks scicos_util : some macros which use scicos_simulate function signal : signal macros routines : scicos blocks computational functions ./interf/scicosLab : interfacing functions for scicoslab demos : demonstrations of scicoslab examples : examples of scicoslab gateway : interfacing functions of scicoslab help : directory of man pages of scicoslab macros : directory of scicoslab macros ********************* COPYRIGHT AND LICENSE ********************* "Modnum" toolbox is based on the thesis work "Development of CAD models for the system level simulation of communication systems" (http://www.unilim.fr/theses/2006/sciences/2006limo0006/notice.htm) With the evolution of the "Modnum" toolbox, a library called "modnum_lib" (dedicated to the modelling and simulation of commmunication systems) is now free. The "modnum_lib" (Copyright (C) 2007-2013 Alan Layec) library is under GPL license. For Modnum realases >= 4.2.1, "modnum_lib" includes all C source files of the toolbox. All source files that you can find in this toolbox that are not included in the "modnum_lib" library and not copyrighted are completely free of use or under Scilab restrictions license. ******* SUPPORT ******* - Support for installation issues, bug fixs and updates of this toolbox, are at this time provided. This can be claimed to alan.layec@cermics.enpc.fr. ****** AUTHOR ****** Alan Layec