![]() This is very useful to quickly find your way in large source distributions. You can configure doxygen to extract the code structure from undocumented source files. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. ![]() It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. Doxygen also supports the hardware description language VHDL. You need to run at least once the shell script present in the prepare_ecm_grids/ directories.Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, and to some extent D. Note than all grids and effective charges of the examples are needed and should be already present in the data_grid/ directory. Optionaly it is possible to activate valgrind (a memory check tool) in run_tests.sh,įor testing the correct initialisation / destruction of objects (applicable mainly with gfortran, and if OpenMP is activated a single error is reported). This executable reads complete sda input files (always sda_energy calculations) and compares the results of forces and energies calculations by all implemented methods.Īn error is generated if some differences between the methods are found. It will loop through unit-test/ subdirectories of the examples and run the executable test_force_energy2. To execute them, go to examples/run_tests/ and run: We have recently implemented some regression tests. We provide this executable in sda_flex/auxi/clust, to compile this call make clust in the src directory.Īnd the documentation at sda_flex/auxi/clustering/doc , basically remove -Xlinker -enable-new-dtagsĪ separate C++ program for clustering is provided with the software release. According to user reports, compilation on MacOS requires the following linker settings (please modify the src/Makefile accordingly):.alternative options : make lib_sda, make sda_flex, make tool, make auxi, make test_module.make, or synonymously, make all : compile the library in lib/ and all executables ( sda_flex and tools).make clean_mod : only delete object files in src/, directories with the executables are not modified.Ĭompile and install to bin/ or bin_arch2/:.make clean : delete all object files in src/ and executables ( in lib/ and bin/ ).Next, clean the object files (recommended): If you want, e.g., to limit runs to 4 CPUs,Įnter export OMP_NUM_THREADS=4 in the console, before running sda_flex variable OpenMP : activates OpenMP, default is "yes".variable debug : default is "no", it activates optimisation and switches off debugging information "yes" sets debugging option on and deactivates optimisation (use only for development).variable CC : compiler executable, default is "gfortran" but compilation has been tested with Intel and (partly) with Portland and XLF compilers.To compile the SDA executable ( sda_flex), the library ( libsda.so) and the tools go to the src/ directoryĮdit the Makefile and adapt these parameters to your needs:
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |