Skip to content

Commit

Permalink
doc: changed python/pip -> python3/pip3
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Papior <[email protected]>
  • Loading branch information
zerothi committed Sep 25, 2019
1 parent e985d9d commit 4e501b0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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=<prefix>
python3 setup.py install --prefix=<prefix>

If trying to install without root access, you may be required to use this command:

python setup.py install --user --prefix=<prefix>
python3 setup.py install --user --prefix=<prefix>


Once installed, the installation can be tested by executing the following:
Expand Down
26 changes: 13 additions & 13 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -79,19 +79,19 @@ 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 <gh-releases_>`_, or clone
the `git repository <sisl-git_>`_ for the latest developments

.. code-block:: bash
python setup.py install --prefix=<prefix>
python3 setup.py install --prefix=<prefix>
Testing your installation
Expand All @@ -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 <sisl-git_>`_.
Remark that the :code:`git+https` protocol is buggy (as of pip v19.0.3) because you cannot pass compiler
Expand All @@ -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.

0 comments on commit 4e501b0

Please sign in to comment.