|
|
|
# Obtaining Zodiac
|
|
|
|
To obtain Zodiac, you need a [git](https://git-scm.com/) installation. Then just do:
|
|
|
|
```
|
|
|
|
git clone https://software.crsim.utah.edu:8443/James_Research_Group/Zodiac.git
|
|
|
|
```
|
|
|
|
|
|
|
|
# Building Zodiac
|
|
|
|
|
|
|
|
## Required Dependencies
|
|
|
|
To build Zodiac, you will need a few things installed on your machine:
|
|
|
|
|
|
|
|
1. Cantera (our modified version). See [here](https://software.crsim.utah.edu/installing-cantera-for-crsim-users/) for instructions on installing cantera.
|
|
|
|
1. [Boost libraries](www.boost.org)
|
|
|
|
1. [CMake](www.cmake.org)
|
|
|
|
1. A modern C++ compiler (C++11 compliant)
|
|
|
|
1. [git](https://git-scm.com/)
|
|
|
|
|
|
|
|
With these, building Zodiac is fairly straightforward:
|
|
|
|
```
|
|
|
|
mkdir build; cd build
|
|
|
|
cmake [path to source]
|
|
|
|
make
|
|
|
|
```
|
|
|
|
|
|
|
|
A few flags are available to customize the build:
|
|
|
|
|
|
|
|
| Flag | Value | Description |
|
|
|
|
| --------------------------- | --------- | -------- |
|
|
|
|
| `-DCantera_DIR` | path to cantera installation | Allows you to point to a custom cantera installation directory. This shouldn't be needed if cantera is installed in typical spaces like `/usr/local` or `/usr` |
|
|
|
|
| `-DCMAKE_BUILD_TYPE` | `Release` (default) or `Debug` | Allows you to control the build type |
|
|
|
|
| `-DCMAKE_INSTALL_PREFIX` | path to installation | Allows you to control where the executable will be installed |
|
|
|
|
|
|
|
|
# Running Zodiac
|
|
|
|
Once you have a build, try: `zodiac --help` which will produce a summary of the commands that zodiac accepts on the command line. |
