Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Updated README with markdown formatting and better instructions. Updated .gitignore to allow for empty build dir
  • Loading branch information
daminton committed Dec 14, 2020
1 parent 6d42009 commit 8135f3d
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 8 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ build/src/CTEM
*.swp


build/

configure

config/
Expand Down
22 changes: 16 additions & 6 deletions README
Original file line number Diff line number Diff line change
@@ -1,29 +1,39 @@
Installing CTEM for code development
### Installing CTEM for code development
************************************

CTEM uses Autotools to automate makefile generation. To set up your system,
first run the script
$ ./autogen.sh

`$ ./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:
$ mkdir build

```
$ cd build
$ ../configure
$ make clean
$ make
```

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


Running CTEM
************************************
### Running CTEM
************************************
An example CTEM simulation is included in the idl directory. You can execute the
CTEM run using the IDL frontend using:
$ idl < start.in

`$ 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.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
### Installing CTEM for code development
************************************

CTEM uses Autotools to automate makefile generation. To set up your system,
first run the script

`$ ./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:

```
$ cd build
$ ../configure
$ make clean
$ make
```

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:

`$ 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.
2 changes: 2 additions & 0 deletions build/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*
!.gitignore

0 comments on commit 8135f3d

Please sign in to comment.