search

amepproject / amep

The Active Matter Evaluation Package (AMEP) - a Python library for the analysis of particle-based and continuum simulation data of soft and active matter systems
https://amepproject.de/
GNU General Public License v3.0
11 stars 2 forks source link

DOC: incorrect spatialcor.pcf_angle example #11

Closed hechtprojects closed 5 months ago

hechtprojects commented 6 months ago

Problem description:

https://amepproject.de/_autosummary/amep.spatialcor.pcf_angle.html

Within the example, the line import numpy as np is missing. Additionally, the plotting is incorrect.

Suggested content improvement:

Add >>> import numpy as np to the example in the doc string of amep.spatialcor.pcf_angle.

Replace the line mp = amep.plot.field(axs, grt, X, Y) with mp = amep.plot.field(axs, grt.T, X, Y) and add the resulting figure to the documentation.

hechtprojects commented 5 months ago

I updated the example and added the corresponding figure to the documentation. The changes will be part of patch release v1.0.1.