Skip to content

Commit

Permalink
Update various links on website (#4811)
Browse files Browse the repository at this point in the history
  • Loading branch information
philippjfr authored Feb 1, 2021
1 parent 78d8b19 commit 3599ba4
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 57 deletions.
32 changes: 14 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,21 +57,21 @@ Installation

HoloViews works with
[Python 2.7 and Python 3](https://github.com/holoviz/holoviews/actions?query=workflow%3Apytest)
on Linux, Windows, or Mac, and provides optional extensions for working with the
[Jupyter/IPython Notebook](http://jupyter.org).
on Linux, Windows, or Mac, and works seamlessly with
[Jupyter Notebook and JupyterLab](https://jupyter.org).

The recommended way to install HoloViews is using the
[conda](http://conda.pydata.org/docs/) command provided by
[Anaconda](http://docs.continuum.io/anaconda/install) or
[Miniconda](http://conda.pydata.org/miniconda.html):
[conda](https://docs.conda.io/projects/conda/en/latest/index.html) command provided by
[Anaconda](https://docs.anaconda.com/anaconda/install/) or
[Miniconda](https://docs.conda.io/en/latest/miniconda.html):

conda install -c pyviz holoviews bokeh

This command will install the typical packages most useful with
HoloViews, though HoloViews itself depends only on
[Numpy](http://numpy.org) and [Param](https://param.holoviz.org).
[Numpy](https://numpy.org) [Pandas](https:// and [Param](https://param.holoviz.org).
Additional installation and configuration options are described in the
[user guide](http://holoviews.org/user_guide/Installing_and_Configuring.html).
[user guide](https://holoviews.org/user_guide/Installing_and_Configuring.html).

You can also clone holoviews directly from GitHub and install it with:

Expand All @@ -82,29 +82,25 @@ You can also clone holoviews directly from GitHub and install it with:
Usage
-----

Once you've installed HoloViews, you can get a copy of all the
examples shown on the website:
Once you've installed HoloViews, you can get a copy of all the examples shown on this website:

holoviews --install-examples
cd holoviews-examples

And then you can launch Jupyter Notebook to explore them:
Now you can launch Jupyter Notebook or JupyterLab to explore them:

jupyter notebook

To work with JupyterLab you will also need the PyViz JupyterLab
jupyter lab

If you are working with a JupyterLab version <2.0 you will also need the PyViz JupyterLab
extension:

conda install -c conda-forge jupyterlab
jupyter labextension install @pyviz/jupyterlab_pyviz

Once you have installed JupyterLab and the extension launch it with::

jupyter-lab

For more details on setup and configuration see [our website](http://holoviews.org/user_guide/Installing_and_Configuring.html).
For more details on setup and configuration see [our website](https://holoviews.org/user_guide/Installing_and_Configuring.html).

For general discussion, we have a [gitter channel](https://gitter.im/pyviz/pyviz).
If you find any bugs or have any feature suggestions please file a GitHub
[issue](https://github.com/pyviz/holoviews/issues)
[issue](https://github.com/holoviz/holoviews/issues)
or submit a [pull request](https://help.github.com/articles/about-pull-requests).
22 changes: 10 additions & 12 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,15 @@ ____________
|CondaPkg|_ |PyPI|_ |License|_ |Coveralls|_


HoloViews works with `Python 2.7 and Python 3 <https://travis-ci.org/holoviz/holoviews>`_ on Linux, Windows, or Mac, and provides optional extensions for working with the `Jupyter/IPython Notebook <https://jupyter.org>`_.
HoloViews works with `Python 2.7 and Python 3 <https://github.com/holoviz/holoviews/actions?query=workflow%3Apytest>`_ on Linux, Windows, or Mac, and works seamlessly with `Jupyter Notebook and JupyterLab <https://jupyter.org>`_.

The recommended way to install HoloViews is using the `conda <https://conda.pydata.org/docs/>`_ command provided by `Anaconda <https://docs.continuum.io/anaconda/install>`_ or `Miniconda <https://conda.pydata.org/miniconda.html>`_::
The recommended way to install HoloViews is using the `conda <https://docs.conda.io/projects/conda/en/latest/index.html>`_ command provided by `Anaconda <https://docs.anaconda.com/anaconda/install/>`_ or `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_::

conda install -c pyviz holoviews bokeh

This command will install the typical packages most useful with HoloViews, though HoloViews itself
directly depends only on `Numpy <https://numpy.org>`_ and `Param <https://param.holoviz.org/>`_.
directly depends only on `Numpy <https://numpy.org>`_, `Pandas <https://pandas.pydata.org>`_ and `Param <https://param.holoviz.org/>`_.

Additional installation and configuration options are described in the
`user guide <user_guide/Installing_and_Configuring.html>`_.

Expand All @@ -96,20 +97,17 @@ Once you've installed HoloViews, you can get a copy of all the examples shown on
holoviews --install-examples
cd holoviews-examples

And then you can launch Jupyter Notebook to explore them::
Now you can launch Jupyter Notebook or JupyterLab to explore them::

jupyter notebook

To work with JupyterLab you will also need the PyViz JupyterLab
jupyter lab

If you are working with a JupyterLab version <2.0 you will also need the PyViz JupyterLab
extension::

conda install -c conda-forge jupyterlab
jupyter labextension install @pyviz/jupyterlab_pyviz

Once you have installed JupyterLab and the extension launch it with::

jupyter-lab

For more details on installing and configuring HoloViews see `the installing and configuring guide <user_guide/Installing_and_Configuring.html>`_.

After you have successfully installed and configured HoloViews, please see `Getting Started <getting_started/index.html>`_.
Expand All @@ -124,8 +122,8 @@ After you have successfully installed and configured HoloViews, please see `Gett
.. |License| image:: https://img.shields.io/pypi/l/holoviews.svg
.. _License: https://github.com/holoviz/holoviews/blob/master/LICENSE.txt

.. |Coveralls| image:: https://img.shields.io/coveralls/pyviz/holoviews.svg
.. _Coveralls: https://coveralls.io/r/pyviz/holoviews
.. |Coveralls| image:: https://img.shields.io/coveralls/holoviz/holoviews.svg
.. _Coveralls: https://coveralls.io/r/holoviz/holoviews

.. toctree::
:titlesonly:
Expand Down
50 changes: 23 additions & 27 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ Installing HoloViews
The quickest and easiest way to get the latest version of all the
recommended packages for working with HoloViews on Linux, Windows, or
Mac systems is via the
`conda <http://conda.pydata.org/docs/>`_ command provided by
`conda <https://docs.conda.io/projects/conda/en/latest/>`_ command provided by
the
`Anaconda <http://docs.continuum.io/anaconda/install>`_ or
`Miniconda <http://conda.pydata.org/miniconda.html>`_ scientific
`Anaconda <https://docs.anaconda.com/anaconda/install/>`_ or
`Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_ scientific
Python distributions::

conda install -c pyviz holoviews bokeh

This recommended installation includes the default `Matplotlib
<http://matplotlib.org>`_ plotting library backend, the
more interactive `Bokeh <http://bokeh.pydata.org>`_ plotting library
backend, and the `Jupyter/IPython Notebook <http://jupyter.org>`_.
backend, and the `Jupyter Notebook <http://jupyter.org>`_.

A similar set of packages can be installed using ``pip``, if that
command is available on your system::
Expand All @@ -28,25 +28,20 @@ HoloViews objects without visualization::

pip install holoviews

This minimal install includes only the two required libraries `Param
<http://param.pyviz.org/>`_ and `Numpy <http://numpy.org>`_,
neither of which has any required dependencies, which makes it very
easy to integrate HoloViews into your workflow or as part of another
project.
This minimal install includes only three required libraries `Param
<https://param.holoviz.org/>`_, `Numpy <https://numpy.org>`_ and,
`pandas <https://pandas.pydata.org/>`_, which makes it very easy to
integrate HoloViews into your workflow or as part of another project.

Alternatively, you can ask ``pip`` to install a larger set of
packages that provide additional functionality in HoloViews::

pip install "holoviews[extras]"
pip install "holoviews[examples]"

This option installs all the required and recommended packages,
including the `pandas <http://pandas.pydata.org/>`_ and `Seaborn
<http://stanford.edu/~mwaskom/software/seaborn/>`_ libraries.
This option installs all the required and recommended packages, in
addition to all all libraries required for running all the examples.

Lastly, to get *everything*, including `cyordereddict
<https://pypi.python.org/pypi/cyordereddict>`_ to enable optional
speed optimizations and `nose <https://pypi.python.org/pypi/nose/>`_
for running unit tests, you can use::
Lastly, to get *everything* including the test dependencies, you can use::

pip install "holoviews[all]"

Expand All @@ -57,16 +52,16 @@ can be installed using::

To get the very latest development version using ``pip``, you can use::

pip install git+https://github.com/pyviz/holoviews.git
pip install git+https://github.com/holoviz/holoviews.git

The alternative approach using git archive (e.g ``pip install
https://github.com/pyviz/holoviews/archive/master.zip``) is *not*
https://github.com/holoviz/holoviews/archive/master.zip``) is *not*
recommended as you will have incomplete version strings.

Anyone interested in following development can get the very latest
version by cloning the git repository::

git clone https://github.com/pyviz/holoviews.git
git clone https://github.com/holoviz/holoviews.git

To make this code available for import you then need to run::

Expand All @@ -82,18 +77,19 @@ Jupyter Notebook::

jupyter notebook

To work with JupyterLab you will also need the PyViz JupyterLab
To work with JupyterLab>2.0 you won't need to install anything else,
however for older versions you should also install the PyViz
extension::

conda install -c conda-forge jupyterlab
jupyter labextension install @pyviz/jupyterlab_pyviz

Once you have installed JupyterLab and the extension launch it with::

jupyter-lab
jupyter lab

Now you can download the `tutorial notebooks`_. unzip them somewhere
Jupyter Notebook can find them, and then open the Homepage.ipynb
tutorial or any of the others in the Notebook. Enjoy exploring your
data!
Now that you are set up you can get a copy of all the examples shown
on this website::

holoviews --install-examples
cd holoviews-examples

0 comments on commit 3599ba4

Please sign in to comment.