FRQ: Plot arrows for annotations.

[hechtprojects]

Proposed new feature or change:

Add the following method (+ docstring + example) to amep.plot:

def draw_arrow(fig, x, y, dx, dy, **kwargs):
    arrow = FancyArrow(x, y, dx, dy, transform=fig.transFigure, length_includes_head=True, **kwargs)
    fig.add_artist(arrow)

This allows to draw an arrow that points from (x, y) to (x+dx, y+dy), which is useful for annotation purposes.

[suvendu266]

I have tested this issue using a simple script
import amep
import numpy as np
start_points = [(0.2, 0.2), (0.4, 0.4), (0.6, 0.6), (0.8, 0.8)]
displacements = [(0.1, 0.05), (-0.05, 0.1), (0.05, -0.05), (-0.1, -0.1)]

fig, axs = amep.plot.new(figsize=(3, 3))

Draw arrows for each starting point and displacement

for (x, y), (dx, dy) in zip(start_points, displacements):
amep.plot.draw_arrow(fig, x, y, dx, dy, color="blue", alpha=0.8, width=0.005, head_width=0.02, head_length=0.03)

#I have add the following code inside the plot.py

Define the draw_arrow function

def draw_arrow(fig, x, y, dx, dy, **kwargs):
"""
Draws an arrow on a Matplotlib figure.

Parameters:
    fig (Figure): Matplotlib figure object.
    x (float): Starting x-coordinate of the arrow (in figure coordinates).
    y (float): Starting y-coordinate of the arrow (in figure coordinates).
    dx (float): Displacement along x-axis.
    dy (float): Displacement along y-axis.
    **kwargs: Additional arguments passed to FancyArrow.
"""
arrow = FancyArrow(x, y, dx, dy, transform=fig.transFigure, length_includes_head=True, **kwargs)
fig.add_artist(arrow)  

[suvendu266]

I think that this issue is completed.