Commit cf59c53d authored by Tilman Steinweg's avatar Tilman Steinweg
Browse files

updated documentation due to new Makefile

parent 4344b324
......@@ -8,13 +8,13 @@ Get started:
- See `README.md` in `par/`
Documentation:
- Type `make` in `doc/`
- Type `make doc` in `build/`
Contributing:
- See the contributing guidelines provided in `CONTRIBUTING.md`
Requirement:
- Framework [LAMA](https://www.libama.org) Version >= 2.1
- Framework [LAMA](https://www.libama.org) Version >= 2.2.0
- Compiler with C++11 support
Tested with:
......
*
\ No newline at end of file
......@@ -111,7 +111,7 @@ AR := ar
ARFLAGS := cr
RM := rm -f --preserve-root
.PHONY: help all doc clean distclean vinfo html pdf utest itest lib prog
.PHONY: help all doc clean distclean vinfo doxygen theory utest itest lib prog
help:
@echo
......@@ -122,7 +122,7 @@ help:
@echo " all :: equivalent to \"$(MAKE) lib prog doc utest itest\""
@echo " lib :: build archive lib$(wave.lib).a"
@echo " prog :: build executable $(wave.exe) (and, implicitly, lib)"
@echo " doc :: build html and pdf (theory) documentation"
@echo " doc :: build html (make doxygen) and pdf (make theory) documentation"
@echo " utest :: build unit tests"
@echo " itest :: build integration tests"
@echo " clean :: remove object files"
......@@ -182,9 +182,9 @@ distclean: clean
vinfo: prog
$(Q)strings $(wave.bindir)/$(wave.exe) | grep _KITGPI_LINK_
doc: html pdf
html: $(wave.docdir)/doxygen/html/index.html
pdf: $(wave.docdir)/theory/WAVE_guide_EN.pdf
doc: doxygen theory
doxygen: $(wave.docdir)/doxygen/html/index.html
theory: $(wave.docdir)/theory/WAVE_guide_EN.pdf
$(wave.docdir)/doxygen/html/index.html: $(wave.dir)/doc/doxygen/Doxyfile $(wave.liballsrc)
@echo " [DOC] $@"
......
all: install
install: install_theory install_doxygen
install_theory:
$(MAKE) -C theory/ install
install_doxygen:
$(MAKE) -C doxygen/ install
# Documentation
Use the Makefile in build directory to build the documentation
- Complete documentation: `make all`
- Complete documentation: `make doc`
## Documentation for theory
- Make target `make install_theory`
- Make target `make theory`
- Output: `theory/WAVE_theory_EN.pdf`
- Requirement: *pdflatex* and *bibtex*
## Documentation for source code
- Make target `make install_doxygen`
- Make target `make doxygen`
- Output: `doxygen/html/index.html`
- Requirement: *doxygen*
......@@ -1036,13 +1036,13 @@ As preparatory steps environment variables have to be linked to LAMA. Add the fo
\\\shellcmdline{ `export OMP\_NUM\_THREADS=1`}\\
You can also find the instructions in \shellcmd{FDSimulation\_LAMA/par/README.md}.
Change to the directory: \\\shellcmdline{FDSimulation\_LAMA/src/}
Change to the directory: \\\shellcmdline{FDSimulation\_LAMA/build/}
You can compile the source code by simply entering: \\\shellcmdline{make sofi}\\ in your command line. \gCC is set to be the default \CC-compiler. To use an alternative compiler, the compiler setting can be change in the \shellcmd{Makefile}, or otherwise by executing:\\\shellcmdline{make CC=<yourCompiler> sofi}
You can compile the source code by simply entering: \\\shellcmdline{make prog}\\ in your command line. \gCC is set to be the default \CC-compiler. To use an alternative compiler, the compiler setting can be change in the \shellcmd{Makefile}, or otherwise by executing:\\\shellcmdline{make CXX=<yourCompiler> sofi}
The runtime configuration (such as the FD grid) can be changed in the \shellcmd{configuration.txt} file, located in the directory \shellcmd{FDSimulation\_LAMA/par/configuration/}. A list of all input variables and their dependencies can be found in section \ref{sec:config}.
To create a html and LaTeX or Pdf documentation of the software code itself, you can generate a doxygen documentation. Therefore change the directory to \shellcmd{FDSimulation\_LAMA/doc/} and run the command \shellcmd{make}. After running doxygen, the html, LaTeX and Pdf version of the reference manual can be found in \shellcmd{doc/html/} and \shellcmd{doc/latex/}.
To create a html and LaTeX or Pdf documentation of the software code itself, you can generate a doxygen documentation. Therefore change the directory to \shellcmd{FDSimulation\_LAMA/build/} and run the command \shellcmd{make doc}. After running doxygen, the html, LaTeX and Pdf version of the reference manual can be found in \shellcmd{build/doc/doxygen/} and \shellcmd{build/doc/theory/}.
\subsection{Example}
......@@ -1231,10 +1231,10 @@ As preparatory steps environment variables have to be linked to googletest. Add
\\\shellcmdline{ `export LD\_LIBRARY\_PATH=\$\{GTEST\_DIR\}:\$\{LD\_LIBRARY\_PATH\}`}
\\\shellcmdline{ `export DYLD\_LIBRARY\_PATH=\$\{GTEST\_DIR\}:\$\{DYLD\_LIBRARY\_PATH\}}
To compile all tests, change the directory: \\\shellcmdline{FDSimulation\_LAMA/src/} \\ and compile the tests by simply entering:\\\shellcmdline{make tests}
To compile all tests, change the directory: \\\shellcmdline{FDSimulation\_LAMA/src/} \\ and compile the tests by simply entering:\\\shellcmdline{make utest} and \shellcmdline{make itest}
The executable file is located in the directory:
\\\shellcmdline{FDSimulation\_LAMA/bin/Tests/}\\
\\\shellcmdline{FDSimulation\_LAMA/build/bin}\\
To execute the unit-tests change to the \shellcmd{/par} folder and run the \shellcmd{Test\_unit} file by entering:
\\\shellcmdline{./../bin/Tests/Test\_unit}\\
For faultless function of FDSimulation\_LAMA all tests should execute without failure.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment