OpenFLIP Demo Addon - bakcxoj/OpenFLIP GitHub Wiki

The OpenFLIP Demo addon is a very limited version of the full release addon. The demo will only allow you to run predefined scenes at preset resolutions called test cases. The demo will still allow you to playback and render your test case simulation. This version of the addon was used during the beta to test the simulator on beta testers' machines and diagnose hardware compatibility issues.

The OpenFLIP Demo Addon may be downloaded here (flip_fluids_demo-0.0.4d-Win-OSX-Linux.zip).

The OpenFLIP Demo Scenes may be downloaded here (flip_fluids_demo_scenes-0.0.4d.zip).

How to Run a Demo Test Case

This guide will detail how to run a demo test case.

1. Install the OpenFLIP Demo addon

The OpenFLIP Demo is a specialized version of the addon that will help you run predefined simulation scenes. The demo addon can be found inside the OpenFLIP Demo Package.

How to Install/Uninstall the Addon

Warning: Only one version of the OpenFLIP addon may be installed at a time. If you currently have another OpenFLIP addon installed, it must first be uninstalled.

2. Select a test case scene

Select a test case simulation scene (.blend file) to run. The test case scenes can be found inside the OpenFLIP Demo Package. You will find descriptions of each demo scene here.

3. Open and run a test case scene

Open the selected test case scene. If the OpenFLIP Demo installed correctly, you should see the test case panel on the right side of the screen under the Blender Physics Properties menu.

  1. Select Test Case Cache Directory: Simulation data files such as meshes and logs will be written to this directory. By default, this directory will be located in the same folder as your downloaded test case scene.
    WARNING: The cache directory should not be set to a location inside of a Dropbox folder. You may get 'Access Denied' errors when the addon attempts to access cache files that the Dropbox application is also accessing.
  2. Select Test Case Resolution: Select one of the preset simulation resolutions. The resolution is the level of detail of the simulation. Higher resolutions will take longer to compute.
  3. Run Test Case: This operator will begin 'baking' the simulation. This process may take a few minutes to many hours depending on your system and the selected scene and resolution. It is not required run the entire simulation at once. You may pause the simulation, close Blender, and resume the simulation at your convenience.
    Wait until the simulation is complete before moving on to the next step. While you wait, you may scroll through the Blender timeline to view your generated meshes!
  4. Export Test Case Results: This operator will export a .zip file of your test case results. More on this step is detailed in the next section.

4. Export test case results

If you have encountered an error or the simulation stopped unexpectedly, you should export your test case results and let us know that the test case failed. You may let us know by messaging us on the Blender Market or emailing us at flip.fluids[at]gmail.com. If you are unsure if the test case ran successfully, feel free to send us the results and we can look over them for you!

  1. Select a location to save the test case results: The results will be saved as a .zip file. Please do not change the file name if you can avoid it.
  2. Click the Export Test Case button: A popup menu will be displayed. Fill out your system information and click OK to export your results.

⚠️ **GitHub.com Fallback** ⚠️