Skip to content

Commit

Permalink
Update build.md regarding cmake
Browse files Browse the repository at this point in the history
  • Loading branch information
millerta authored Jul 7, 2023
1 parent 94da598 commit affb342
Showing 1 changed file with 29 additions and 13 deletions.
42 changes: 29 additions & 13 deletions docs/pages/docs/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,22 @@ Tags: Manual Building an executable and running LaGriT
The executable is built by linking a driver routine with the code and
utility libraries. The driver routine must contain a call to initLaGriT
and a call to control_command_lg and must contain a subroutine called
user_sub.  The input arguments to initLaGriT are:
user_sub. 

The input arguments to initLaGriT are:

**mode** - set to 'noisy' for output to be echoed to the screen - set to
'silent' for no echo

**log_file** - name of log file (if ' ' or '-def-' use default name which
is logx3dgen)  This file will contain a list of commands.
is lagrit.log)  This file will contain a list of commands.

**batch_file** - name of batch file (if ' ' or '-def-' use default name
which is outx3dgen). This file will contain a list of commands and the
which is lagrit.out). This file will contain a list of commands and the
error, warning and informational messages generated by the command.
User_sub is used to implement user commands, see [User Commands](writing.md).

A sample driver routine is listed below:
A sample Fortran driver routine is listed below (C++ examples are in examples/liblagrit/):

<pre>
program adrivgen
Expand Down Expand Up @@ -82,11 +84,31 @@ C For example

### Sample build scripts

LaGriT can be compiled on most modern machines including Linux, Mac, and WINDOWS.
LaGriT can be compiled on most modern machines including Linux, Mac, and WINDOWS. LaGriT uses cmake to build with or without external libraries such as Seacas Exodus.

The most recent instructions can be found on the github pages.


Simple install, build, and test: [LaGriT Github README](https://github.com/lanl/LaGriT/README.md)

Build options and instructions for developers: [LaGriT Github cmake README](https://github.com/lanl/LaGriT/cmake/README.md)



### Running LaGriT

*Note examples may be out of date, see [LaGriT Github](https://github.com/lanl/LaGriT)*
To execute, use standard unix file redirection for standard input and
output. LaGriT will produce two additional files, lagrit.out and
lagrit.log. The user can change the names of these files by supplying new
names as arguments in the call to initLaGriT before compiling.  These files contain
detailed output information and the list of commands respectively.
LaGriT may also be run interactively in which case the user will be
prompted to enter commands at the machine prompt.

lagrit < lagrit_command_file


### The following are examples to build old releases (pre V3.2) but may be helpful on older machines.

**Sun OS and Sun Solaris forte version 7 compiler:**

Expand Down Expand Up @@ -185,10 +207,4 @@ where fdate.f is



To execute, use standard unix file redirection for standard input and
output. LaGriT will produce two additional files, outx3dgen and
logx3dgen. The names of these files can be changed by supplying the
names as arguments in the call to initLaGriT.  These files contain
detailed output information and the list of commands respectively.
LaGriT may also be run interactively in which case the user will be
prompted to enter commands from the workstation.

0 comments on commit affb342

Please sign in to comment.