Add new 3D blob tracking example

[Sven-248]

This PR introduces a new example showcasing 3D blob tracking (#478). In addition, the following updates have been made:

• New example added: A new example for generating and tracking 3D blobs has been added to the example folder

• Environment update: The environment-examples.yml file has been updated to include any necessary dependencies related to the new example

• Test function: A new test function has been added to tobac/testing.py to create a 3D blob

• Minor code adjustments: Added black formatting to jupyter notebooks

• Have you followed our guidelines in CONTRIBUTING.md?

• Have you self-reviewed your code and corrected any misspellings?

• Have you written documentation that is easy to understand?

• Have you written descriptive commit messages?

• Have you added NumPy docstrings for newly added functions?

• Have you formatted your code using black?

• If you have introduced a new functionality, have you added adequate unit tests?

• Have all tests passed in your local clone?

• If you have introduced a new functionality, have you added an example notebook?

• Have you kept your pull request small and limited so that it is easy to review?

• Have the newest changes from this branch been merged?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.61%. Comparing base (f05da21) to head (de83072).

Additional details and impacted files

@@              Coverage Diff              @@
##           RC_v1.6.0     #493      +/-   ##
=============================================
+ Coverage      59.14%   59.61%   +0.46%     
=============================================
  Files             25       25              
  Lines           3892     3937      +45     
=============================================
+ Hits            2302     2347      +45     
  Misses          1590     1590              

Flag	Coverage Δ
unittests	59.61% <100.00%> (+0.46%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

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

[github-actions]

Linting results by Pylint:

Your code has been rated at 8.31/10 (previous run: 8.31/10, +0.00)
_{The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the RC_v1.6.x branch.
A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.}

[Sven-248]

Hi @fsenf, could you please review this PR when you have time?

[fsenf]

@Sven-248 : Thank you for this contribution! I can see that most for our examples were slightly modified. I guess this comes from black changing the quotation marks. Was this indented?

[Sven-248]

@Sven-248 : Thank you for this contribution! I can see that most for our examples were slightly modified. I guess this comes from black changing the quotation marks. Was this indented?

Yes, I ran Black formatting on all Jupyter Notebooks so the formatting is consistent.
Just a small note: the changes in quote style (from ' to ") and the appearance of escaped characters like " in the file diffs are due to how Jupyter notebooks are stored as JSON.
Github shows this (e.g. "test") in diffs, even though the actual code in the notebooks still look normal. So no functional changes here, just formatting.

[fsenf]

Hej @Sven-248 , I made some updates:

1. uncommented plt.show() at several places --> otherwise users don't see the 3d rendering
2. updated the plot with track + projection

Could please consider the following:

1. Update the 3d example data definition such that blob move vertically
2. Update the velocity calculation --> Here, the question is: do we like to split velocities into horizontal and vertical components?
3. area vs. volume calculation: What would be appropriate in 3d?
4. is website rendering working well with interactive plots enabled?

[fsenf]

OK, rendering does not work properly: https://tobac--493.org.readthedocs.build/en/493/examples/Basics/Idealized-Case-3_Tracking-of-a-Test-Blob-in-3D.html

Extra items would be:

• add a nice looking thumbnail
• add 3d example to gallery

[Sven-248]

Closing this PR due to merge conflicts that are easier to resolve in a fresh branch.
Please see the updated version here: #500
Thanks, and let’s continue the review there.