An open source utility for creating publication quality LaTex figures generated from OpenFOAM data files.

foamTEX

An open source utility for creating publication quality LaTex figures
generated from OpenFOAM data files.
Explore the docs »

Report Bug · Request Feature

About The Project

FoamTex is a python biased utility for generating LaTeX scripts from raw OpenFOAM data files. This project is currently in early development.

(back to top)

Getting Started

Installation is supper easy. The main foamTex.py source file can be run out of the box without any prerequisites (other than python3). Note that neither LateX or OpenFOAM are required. If you wish to run foamTEX as an executable follow the instructions bellow (written for bash Unix shell).

Prerequisites

• pyinstaller if you wish to run foamTEX as an executable (see https://pypi.org/project/pyinstaller/)

  pip install pyinstaller

Installation

1. Clone the repo

   git clone https://github.com/LeoTurnell-Ritson/foamTEX.git

2. If you wish to run foamTEX as a pre-compiled executable: Grant execution permissions to Allmake file

   chmod u+x Allmake

3. Run Allmake

   ./Allmake

4. Add foamTEX to path

   export PATH=$PATH:$(pwd)/dist

(back to top)

Usage

To get infoamtion about the usage of foamTEX try the help option with:

foamTex -h

or:

python3 foamTex.py -h

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.md for more information.

(back to top)

Contact

[email protected]

Project Link: https://github.com/LeoTurnell-Ritson/foamTEX

(back to top)