********* WHAT IS ? ********* "MODNUM" is a Scilab/Scicos 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 (3D trajectory Scope, 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 ******* You need a version of Scilab >3.0. Unix/Linux platform -------------------- - Source version (gcc/g77 are supported) - Method A : Construction in Scilab 1 - Run the builder.sce script file provided in the root directory of the toolbox in a scilab session. 2 - To reload the toolbox, simply run the loader.sce script file provided in the root directory of the toolbox in a scilab session or go to the root directory of the toolbox and launch scilab from a terminal prompt. Method B : Construction with Makefile 1 - Go to the root directory of the toolbox and change directory paths specified in the file Makefile.incl. The SCI variable environment must be specified. If you don't have a source version of scilab then change INCLUDE_DIRS paths to : INCLUDE_DIRS=-I$(MODNUM)/routines/sci_headers (don't include a '/' at the end of this paths) then run 'make all' 2 - To reload the toolbox, simply run the loader.sce script file provided in the root directory of the toolbox in a scilab session or go to the root directory of the toolbox and launch scilab from a terminal prompt. Other features provided by Makefile : make clean : remove object files (.o) of routine directories and remove some others backup files (*~) in all directories make distclean : clean all the directories of the toolbox (remove object, routines libraries, macro libraries,...) make targz : make a 'gzipped' tarball file of the toolbox make srctargz : make distclean and a 'gzipped' tarball file of the toolbox - Binary version - Run the loader.sce script file provided in the root directory of the toolbox in a scilab session or go in the root directory of the toolbox and launch scilab from the terminal prompt. Windows platform ----------------- - Source version (VC++ 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 scilab session. 2 - To reload the toolbox, simply run the loader.sce script file provided in the root directory of the toolbox in a scilab session. RMK : * If you don't have a VC++ compiler, you can use LCC-WIN32 (for non-commercial use) and put it into the directory of Scilab. (see : scilab-x.x\lcc\Readme_LCC.txt) * On windows platform : - Fortran routines are not compiled. - Documentation isn't build. - Binary version - Run the loader.sce script file provided in the root directory of the toolbox in a scilab session ************* DOCUMENTATION ************* - The source version and the binary version of this toolbox should include a html format documentation. Main index of this documentation is avialabe by the "whatis.htm" file in the directories MODNUM/man/htm/eng/ et MODNUM/man/htm/fr/. - Only the binary version of this toolbox should include the paper format of the documentation composed with three manuals : * modnum_ref : Reference guide. * modnum_user : User's guide. * modnum_internals : Internal guide. This manuals are avialable in pdf format in the directories MODNUM/man/pdf/eng/ et MODNUM/man/pdf/fr/. - Two languages are supported : english and french but for this time only english documentation is written. - The building of the documentation of this toolbox is possible only in linux environment because this needs some tools like xwd, xfig/transfig, latex2html and a good LaTeX distribution. If you want to try to build the documentation in linux environment, follow this different steps in a scilab session : -->exec(MODNUM+"/loader.sce"); -->exec(MODNUM+"/macros/generate_doc/load_generate_doc_function.sce"); -->generate_mod_num_html('all'); //generate html documentation -->generate_mod_num_guide('ref'); //generate reference guide -->generate_mod_num_guide('user'); //generate user guide -->generate_mod_num_guide('internal'); //generate internal guide - The documentation directory of the toolbox is ./man and contains : ./man/data : directory of MODNUM_data files ./man/demos : directory of demonstration ./man/htm : directory of html files for the scilab web browser ./man/pdf : directory of the guides ./man/sblock_equiv : directory of "super block equivalent model" ./man/tex : directory of sources tex files and others figures ./man/xml : directory of XML files for man pages ./man/web : directory of the web site of the toolbox **************** TOOLBOX CONTENTS **************** ./macros : directory of scilab macros ./macros/generate_doc : macros of the documentation generator. ./macros/gen_doc_util : utility macros for documentation generator. ./macros/xml2tex : macros for convertion between xml and tex files. ./macros/misc : some miscellaneaous macros. ./macros/scicos_blocks : interfacing functions of Scicos blocks Communication : Communication palette NonLinear : NonLinear palette Pll : Phase Locked Loop palette Sinks : Sinks palette Sources : Sources palette Tools : Tools palette ./macros/scicos_util : some macros which use scicos_simulate function. ./macros/signal : signal macros. ./macros/build_util : macros used for the building of the toolbox. ./macros/find_file : macros used for managing files. ./man : directory of man pages and other documentations of the toolbox. -see documentation section- ./routines : directory of C and Fortran routines. ./routines/mod_num_lib : low-level computational routines and interfacing functions. ./routines/scicos : Scicos blocks computational functions. ./scs_diagr : directory of scicos diagram ./scs_diagr/dyna : diagrams of non-Linear chaotic systems. ./scs_diagr/comsys : diagrams of communication systems. ./scs_diagr/pll : diagrams of frequency synthesizer and PLL. ./simu : directory of simulations of communication systems ******* SUPPORT ******* - No support for the installation and the use of this toolbox is provided. The only informations for the installation and the use of this toolbox are avialable via this README file and the others documentation files provided with the toolbox. - Bug corrections and update of this toolbox, concerning change of a major version (x.) of the Scilab software, are at this time provided. Bug corrections and update can be claimed by e-mail to alan.layec@brive.unilim.fr. ****** AUTHOR ****** Alan LAYEC University of Limoges IRCOM 123 Rue Albert Thomas 87000 LIMOGES email : alan.layec@brive.unilim.fr