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
12 stars 2 forks source link

FRQ: simplify how to set the plot style in plot.style() #34

Closed kay-ro closed 1 week ago

kay-ro commented 5 months ago

Proposed new feature or change:

The call of the amep.plot.style() function is different for whether the goal is to set an amep style or the default matplotlib style. To make this functionality more user-friendly, the labels for the styles can be simplified and one added for the default matplotlib style. The following changes would simplify the usage:

When updating the code in compliance with a minor release, please keep it backwards-compatible. Additionally, prepare for a major release with the simplified call arguments by adding a note to the documentation:

.. note:: Deprecates in 2.0.0
          `mpl_default` will be removed in an upcoming major release. Please use "matplotlib".
          "amep_latex" and "amep_standard" will be removed. Please use "latex" and "standard" instead.