-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated readme with new build instructions
- 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.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| ``` |