From f8e7a66167311ef5afb061dfe3edfc9adaab0ca5 Mon Sep 17 00:00:00 2001 From: MintoDA1 <51412913+MintoDA1@users.noreply.github.com> Date: Mon, 11 Sep 2023 07:51:59 -0400 Subject: [PATCH] Updated readme with new build instructions --- README.md | 38 ++++++++------------------------------ 1 file changed, 8 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 8d4f6ef0..da56eee9 100644 --- a/README.md +++ b/README.md @@ -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 +``` \ No newline at end of file