Skip to content

cf-plot (& dependencies) inclusion in cf.environment() #908

@sadielbartholomew

Description

@sadielbartholomew

cf-python has an environment function which reports the versions, and optionally paths to, itself and its dependencies, especially useful for user support where we ask users to share the output they see from that so we can quickly learn about the exact versions they are using for anything relevant. It would be good to have a cf-plot equivalent so that we can use it in cf-plot itself (users may not be using cf-python explicitly, so have to import cf to access it in code importing only cf-plot) and notably get information about extra cf-plot dependencies such as Cartopy etc.

I propose:
1. We create a cf-plot equivalent, cfp.environment(), which wraps cf-python to report on anything cf-python needs, since cf-python is a cf-plot dependency, but adds any further dependencies cf-plot has to the list. This separates concerns nicely.
2. cf.environment actually reports the version of cf-plot and some of its dependencies (notably matplotlib) despite these not being relevant to cf-python itself, so I also propose we move anything relating to cf-plot such as cf-plot and matplotlib out of that and into cfp.environment().

[Proposal changed - see next comment bold text. Ultimately, we want to provide a way to get crucial version and dependency information for both cf-python separately and cf-python plus cf-plot.]

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions