From 4e501b01c3d0a3341a19b4dfc41bc5cc9130fdaa Mon Sep 17 00:00:00 2001 From: Nick Papior Date: Wed, 25 Sep 2019 12:49:11 +0200 Subject: [PATCH] doc: changed python/pip -> python3/pip3 Signed-off-by: Nick Papior --- README.md | 8 ++++---- docs/installation.rst | 26 +++++++++++++------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index c4a93c94e..944012f75 100644 --- a/README.md +++ b/README.md @@ -61,8 +61,8 @@ which may be analysed using VMD, XCrySDen or other tools. Installing sisl using PyPi or Conda is the easiest: - pip install sisl - pip install sisl[analysis] # also installs tqdm and xarray + pip3 install sisl + pip3 install sisl[analysis] # also installs tqdm and xarray # or conda install -c conda-forge sisl @@ -82,11 +82,11 @@ If performing a manual installation, these packages are required: Subsequently manual installation may be done using this command: - python setup.py install --prefix= + python3 setup.py install --prefix= If trying to install without root access, you may be required to use this command: - python setup.py install --user --prefix= + python3 setup.py install --user --prefix= Once installed, the installation can be tested by executing the following: diff --git a/docs/installation.rst b/docs/installation.rst index 119b68a1b..e8bf867ae 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -32,29 +32,29 @@ Cython version. Note that this is not a necessary step and should typically only be considered by developers of Cython modules. -pip ---- +pip3 +---- Installing sisl using PyPi can be done using .. code-block:: bash - pip install sisl + pip3 install sisl # or - pip install sisl[analysis] + pip3 install sisl[analysis] -:code:`pip` will automatically install the required dependencies. The optional dependencies +:code:`pip3` will automatically install the required dependencies. The optional dependencies will be used if later installed. The latter installation call also installs :code:`tqdm` and :code:`xarray` which are part of extended analysis methods. These are not required and may be installed later if their usage is desired. -When wanting to pass options to :code:`pip` simply use the following +When wanting to pass options to :code:`pip3` simply use the following .. code-block:: bash - pip install --install-option="--compiler=intelem" --install-option="--fcompiler-intelem" sisl + pip3 install --install-option="--compiler=intelem" --install-option="--fcompiler-intelem" sisl note that options are accummulated. @@ -79,11 +79,11 @@ Manual installation sisl may be installed using the regular `setup.py` script. Ensure the required dependencies are installed before proceeding with the manual installation (without `numpy`_ installed a spurious error message will -appear). The dependencies may be installed using this :code:`pip` command: +appear). The dependencies may be installed using this :code:`pip3` command: .. code-block:: bash - pip install -r requirements.txt + pip3 install -r requirements.txt Simply download the release tar from `this page `_, or clone @@ -91,7 +91,7 @@ the `git repository `_ for the latest developments .. code-block:: bash - python setup.py install --prefix= + python3 setup.py install --prefix= Testing your installation @@ -111,11 +111,11 @@ Testing the installation may be done by: Development version ------------------- -To install the development version using :code:`pip` you may use the URL command: +To install the development version using :code:`pip3` you may use the URL command: .. code-block:: bash - pip install git+https://github.com/zerothi/sisl.git + pip3 install git+https://github.com/zerothi/sisl.git Otherwise follow the manual installation by cloning the `git repository `_. Remark that the :code:`git+https` protocol is buggy (as of pip v19.0.3) because you cannot pass compiler @@ -126,6 +126,6 @@ the Intel compilers you should do: git clone git+https://github.com/zerothi/sisl.git cd sisl - pip install --global-option="build" --global-option="--compiler=intelem" --global-option="--fcompiler=intelem" . + pip3 install --global-option="build" --global-option="--compiler=intelem" --global-option="--fcompiler=intelem" . which will pass the correct options to the build system.