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.

Sign up for GitHub

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

documentation updated #5

Merged
merged 1 commit into from
Nov 4, 2024
Merged

documentation updated #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,15 @@ Installation

Pyranges Plot requires Python ≥ 3.12 and can be installed using pip.

As the plot production can based on either Plotly or Matplotlib, the graphic library-specific
installations are enabled. This way if the user wants to install exclusively the dependencies
correspondent to one of those libraries it can be done by running just one of the following
commands: ::
Pyranges Plot supports two alternative graphical libraries ("engines"): plotly and matplotlib.
At least one must be installed. Use these commands to install Pyranges Plot together with
your engine of choice::

pip install pyranges-plot[plotly]

pip install pyranges-plot[matplotlib]

To install all dependencies in order to be able to use both engines' functionalities,
the [all] option must be specified: ::
To install both engines, use instead::

pip install pyranges-plot[all]

Expand Down
Loading
Loading