-
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 markdown formatting and better instructions. Updated .gitignore to allow for empty build dir
- Loading branch information
Showing
4 changed files
with
57 additions
and
8 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 |
|---|---|---|
|
|
@@ -10,8 +10,6 @@ build/src/CTEM | |
| *.swp | ||
|
|
||
|
|
||
| build/ | ||
|
|
||
| configure | ||
|
|
||
| config/ | ||
|
|
||
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,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. |
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 |
|---|---|---|
| @@ -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. |
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 |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| * | ||
| !.gitignore |