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

Fix and improve install section #794

Merged
merged 6 commits into from
Feb 13, 2023
Merged

Conversation

PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Feb 9, 2023

Fix and improve the section concerning installation without an internet connection.
Also improve the regular install section by mentioning the [plotting] option.

@PProfizi PProfizi added the documentation Improvements or additions to documentation label Feb 9, 2023
@PProfizi PProfizi self-assigned this Feb 9, 2023
docs/source/getting_started/install.rst Outdated Show resolved Hide resolved
docs/source/getting_started/install.rst Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Feb 9, 2023

Codecov Report

Merging #794 (6d0f13f) into master (911dc9a) will increase coverage by 0.11%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #794      +/-   ##
==========================================
+ Coverage   88.61%   88.72%   +0.11%     
==========================================
  Files          72       72              
  Lines        8180     8180              
==========================================
+ Hits         7249     7258       +9     
+ Misses        931      922       -9     


Beware that PyDPF-Core wheelhouses do not include the optional plotting dependencies.
To allow for plotting capabilities, also download the wheels corresponding to your platform and Python interpreter version
for `PyVista <https://pypi.org/project/pyvista/#files>`_ and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could mention the versions for PyVista and Matplotlib (the url points to the latest)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rafacanton the thing is these are going to change all the time. We are supposed to support the latest versions of each.
The current limitation on PyVista is actually only for the documentation generation pipeline on GitHub since there is an issue I have not been able to reproduce locally.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PProfizi OK, if we are always going to support the last one, then it LGTM!

@rafacanton rafacanton self-requested a review February 10, 2023 10:14
@PProfizi PProfizi merged commit cad623f into master Feb 13, 2023
@PProfizi PProfizi deleted the doc/fix_and_improve_install branch February 13, 2023 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants