Skip to content

Commit

Permalink
Updated readme with new build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
MintoDA1 authored and MintoDA1 committed Sep 11, 2023
1 parent 0172c49 commit f8e7a66
Showing 1 changed file with 8 additions and 30 deletions.
38 changes: 8 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,17 @@
### Installing CTEM for code development
************************************

CTEM uses Autotools to automate makefile generation. To set up your system,
first run the script
CTEM uses CMake to automate the build process. You will need at least version 3.6.0.

`$ ./autogen.sh`

You may have to modify the contents of src/Makefile.am in order to set the
appropriate flags for your compiler. The default file contains examples of
common flags (optimized code vs. debugging code) for gfortran and ifort. Simply
activate the appropriate set of flags for your system.

From then on, you simply need to execute the following:
To build the executable and all artifacts in a directory called `build/`, simply run the following commands from the CTEM root directory:

```
$ cd build
$ ../configure
$ make clean
$ make
$ cmake -B build -S .
$ cmake --build build
```

The executable that is generated is `build/src/CTEM`


************************************
### Running CTEM
************************************
An example CTEM simulation is included in the idl directory. You can execute the
CTEM run using the IDL frontend using:
To clean all build artifacts, you can execute the included `distclean.cmake` script with the following command:

`$ idl < start.in`

Alternatively you may wish to use the Python front end.


`$ python3 ctem_driver.py`

The run parameters are controlled by the ctem.in file.
```
$ cmake -P distclean.cmake
```

0 comments on commit f8e7a66

Please sign in to comment.