Lorenz Attractor Simulation

Lorenz Attractor simulation in C++ with OpenGL.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

The software is an implementation of the lorenz system simulation using C++ and OpenGL 4.5 using volume rendering technique to visualize the output data for the solution of the set of differential equations.

In general the system is a simplified model of atmospheric convection developed by Edward Lorenz with the help of Ellen Fetter and Margaret Hamilton, this model is a set of 3 ODEs (Ordinary Differential Equations) known as the Lorenz Equations

The model:

The model is concerned with the properties of a two-dimensional layer of fluid being heated uniformly from below while being cooled uniformly from above.

Built With

• OpenGL
• GLFW
• GLAD
• GLM
• imgui
• CMake

(back to top)

---

Getting Started

Prerequisites

• The project uses CMake for its build, so make sure you have it installed and working properly on your machine.
• This project uses OpenGL API 4.5, so make sure your video card supports this version.
• If you are using a windows machine, I recommend to have installed VisualStudio to facilitate the build.

Installation

1. Clone the repository recursively.

   git clone https://github.com/JoaoMario109/lorenz-attractor.git --recursive

2. Create a build directory after change to the new created build directory and generate the project build files.

   mkdir build
   cd build
   cmake ..

3. Build the project 3.1. In linux use make to build

   make

   3.2. In windows just open the .sln file generated with VisualStudio and after that build the project.

(back to top)

---

Usage

To launch the software just execute the generated executable in the build directory.

(back to top)

---

Contributing

All contributions are welcome to the project.

When contributing to the project, make sure to ident your code using tabs with size 4, also make sure to take a better look in the conventions used in the code and try to follow it, this helps keep the code uniform, easy to understand.

Also remember the branch structures of the project

• master -> This branch only contains releases that are approved to deployment
• develop -> This branch only contains complete implemented and working features, all code submitted to these branch should compile without any compiler error.
• {developer-short-name}/{feature-description} -> Any code in development or feature improvement.

1. Get the last develop and use as base for your branch
2. Create your branch (git checkout -b {developer-short-name}/{feature-description})
3. Make your changes to the code
4. Add only needed changes to staged
5. Commit your changes with good titled and description messages (git commit)
6. Push to the branch (git push origin {developer-short-name}/{feature-description})
7. Open a PullRequest to develop
8. Await reveal and approval to rebase and merge

(back to top)

---

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

---

Contact

João Mário Carnieletto Izoton Lago - Joao Mario

Project Link: https://github.com/JoaoMario109/lorenz-attractor

(back to top)