Skip to content

Document matplotlib dependency/ install matplotlib in CI #13335

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

Closed
qinhanmin2014 opened this issue Feb 28, 2019 · 13 comments · Fixed by #14322
Closed

Document matplotlib dependency/ install matplotlib in CI #13335

qinhanmin2014 opened this issue Feb 28, 2019 · 13 comments · Fixed by #14322
Labels
Build / CI Documentation Easy Well-defined and straightforward way to resolve good first issue Easy with clear instructions to resolve help wanted

Comments

@qinhanmin2014
Copy link
Member

We've introduced matplotlib dependency in some functions, e.g., plot_tree
(1) We need to document the min version we require (the minimal version of matplotlib for Ubuntu 16.04 is 1.5.1). Maybe also document the classes/functions which depend on matplotlib
(2) We need to install matplotlib in CIs
(3) Maybe we can remove some redundant code, e.g.,

else:
# matplotlib <1.5 requires explicit boxstyle
self.bbox_args['boxstyle'] = "square"

@jnothman jnothman added this to the 0.21 milestone Mar 1, 2019
@qinhanmin2014 qinhanmin2014 added Easy Well-defined and straightforward way to resolve good first issue Easy with clear instructions to resolve labels Mar 13, 2019
@maftabali
Copy link
Contributor

@qinhanmin2014 do you want just the modules/tree.rst updated to include this dependency or is there other documents that need this added as well?

@jnothman
Copy link
Member

jnothman commented Mar 18, 2019 via email

@qinhanmin2014
Copy link
Member Author

I can't see anywhere where we obviously state the requirements for running
examples, which should also include versions. I vote for including it in
doc/install.rst

@jnothman readme?
For running the examples Matplotlib >= 1.5.1 is required. A few examples require scikit-image >= 0.12.3, a few examples require pandas >= 0.18.0 and a few example require joblib >= 0.11.

@jnothman
Copy link
Member

jnothman commented Mar 18, 2019 via email

@qinhanmin2014
Copy link
Member Author

I only suggest install.rst because other dependency versions are listed there

I mean we obviously state the requirements for running examples in README.rst and I think that's enough. If you want to copy it to install.rst, let's do it.

@jnothman
Copy link
Member

jnothman commented Mar 19, 2019 via email

@maftabali
Copy link
Contributor

Ok. Will do it later tonight.

@jnothman
Copy link
Member

@maftabali can we pass this onto someone else?

@maftabali
Copy link
Contributor

@jnothman sorry, been snowed under. Do you want this just in the readme or in the install.rst as well?

@jnothman
Copy link
Member

README is fine. You're welcome to say someone else should take it.

@maftabali
Copy link
Contributor

@jnothman If it needs doing straight away, please feel free to pass it someone else as it will take me a while to get to it.

@rth
Copy link
Member

rth commented Apr 24, 2019

(2) We need to install matplotlib in CIs

Not all CIs though -- as it's still an optional dependency, and we want to check that tests can run without it.

@NicolasHug
Copy link
Member

FYI, we added matplotlib checks for the pylatest_conda CI env in #12599

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build / CI Documentation Easy Well-defined and straightforward way to resolve good first issue Easy with clear instructions to resolve help wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants