3d Visualizations of optimization problems

[shammeer-s]

Sandbox Version: These changes are added as a sandbox version of slice_plot. It can be imported using om.sandbox.slice_plot_3d

Summary of changes

1. slice_plot_3d now supports surface and contour projections.
2. Introduction of layout_kwargs and make_subplot_kwargs for easier layout and subplot control. Users can adjust figure size, spacing, shared axes, and grid structure effortlessly.
3. plot_kwargs allows users to customize visual aspects (line color, scatter size, surface colorscale, contour smoothness) for each plot type individually.
4. Added a new notebook, how_to_slice_plot_3d.ipynb, with detailed examples and use cases to assist with adoption.

Future Improvements

1. Improved plot headings, refined 3D surface scene settings, customized axis ticks/labels, and subplot titles for clearer grids.
2. Reducing redundant grid evaluations to improve computational efficiency.

Note: An extensive parameter usage is provided in the attached notebook (Inside the .zip), advanced_slice_plot_3d_usage.zip. Example outputs are also included below in this comment.

[timmens]

Hey,

Thanks for the PR!

Before I start a thorough review of your changes, lets tackle some high-level issues:

1. Can you move the code from plot_data.py into the slice_plot.py module, unless it is also used in other plotting functions.
2. Can you re-order the functions such that the function that is exported by the module (slice_plot) is at the beginning, then the private slice plot functions, and lastly the plotting data code.
3. Can you create a small notebook where you showcase the usage of the new features (this does not need to pushed, you can just upload it in a comment here).

Thanks a lot! If you have any questions, let me know here or on Zulip!

[shammeer-s]

Hey @timmens,

Thanks for the feedback!

Sure, I’ll move the code from plot_data.py into slice_plot.py as suggested, since it’s not being used elsewhere. I’ll also re-order the functions so that the exported slice_plot function comes first.

I'll work on a small notebook to demonstrate the new features and share it here once it’s ready.

Also, I’ll take this opportunity to improve the modularity of the plotting logic a bit—cleaning it up should make the flow easier to understand.

Let me know if there's anything else I should add or keep in mind!

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[codecov]

Codecov Report

Attention: Patch coverage is 17.22973% with 245 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/optimagic/visualization/slice_plot_3d.py	16.38%	245 Missing ⚠️

Files with missing lines	Coverage Δ
src/optimagic/__init__.py	93.33% <100.00%> (ø)
src/optimagic/sandbox.py	100.00% <100.00%> (ø)
src/optimagic/visualization/slice_plot_3d.py	16.38% <16.38%> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.