Skip to content

Commit

Permalink
mentioned installation via pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
GuenterQuast committed Mar 19, 2021
1 parent 71f1c46 commit 3924d89
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,27 @@ Cerated by:
Installation:
-------------

To use PhyPraKit, it is sufficient to place the directory
`PhyPraKit` (containing the files `__init__.py`, `_version_info.py`,
`PhyPraKit.py` and `phyFit.py`) in the same directory as the
python scripts importing the PhyPraKit package.
To use PhyPraKit, it is sufficient to place the the direcotory
`PhyPraKit` and all the files in it in the same directory as the
python scripts importing it.

Installation via `pip` is supported. The recommendation is
to use the installation package in the subdirectory `dist/` and
install in user space:
Installation via `pip` is also supported. After Downloading, execute:

``pip install --user .``

in the main directory of the *PhyPraKit* package (where *setup.py*
is located) to install in user space.

The installation using the *whl*-package provided in the subdirectory
`dist` may also be used:

``pip install --user --no-cache PhyPraKit<version>.whl``

Installation via the PyPi Python Package Index is also available, simply
execute:

``pip install --user PhyPraKit``

``pip install --user --no-cache PhyPraKit<vers.>``


Übersicht:
Expand Down
3 changes: 2 additions & 1 deletion builddoc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ Installation via `pip` is also supported. After Downloading, execute:
in the main directory of the *PhyPraKit* package (where *setup.py*
is located) to install in user space.

The installation *whl*-package in the subdirectory `dist` may also be used:
The installation via the *whl*-package provided
in the subdirectory `dist` may also be used:

``pip install --user --no-cache PhyPraKit<version>.whl``

Expand Down

0 comments on commit 3924d89

Please sign in to comment.