Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds entry point to create matplotlibrc parameters file #773

Merged
merged 1 commit into from
Jan 5, 2024

Commits on Jan 4, 2024

  1. Adds entry point to create matplotlibrc parameters file

    Closes #761
    
    Introduces the `topostats create-matplotlibrc` sub-command/entry point to write the default style
    file (`topostats/topostats.mplstyle`) to disk for modification and subsequent usage. The path and filename can be
    customised when invoking.
    
    This doesn't necessarily mean that all aspects of image plotting are controlled since we set default filenames, titles
    and DPI and whether an image is in the `core` set via the `topostats/plotting_dictionary.yaml` file.
    
    Documentation has been added that, hopefully, clarifies how to use this and points users users to the relevant
    Matplotlib documentation.
    
    Any further tweaking beyond the current state I feel pulls us towards writing a whole API for Matplotlib which is
    something that I am keen to avoid as users would be better served using the examples shown in the Notebook on [plotting
    scans](https://github.com/AFM-SPM/TopoStats/blob/main/notebooks/03-Plotting-scans.ipynb) to customise their plots to
    their own preferences.
    ns-rse committed Jan 4, 2024
    Configuration menu
    Copy the full SHA
    4db0bad View commit details
    Browse the repository at this point in the history