diff --git a/docs/installation.rst b/docs/installation.rst index adb4bc6..9ad0057 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,6 +1,32 @@ Installation ============ +**From PyPi** - The simplest is to install hummingbird directly from pypi: + +:: + + $ pip install hummingbird + + +**From Source** - If you wish to install from source, you can do so by cloning the git repository: + +:: + + $ git clone https://github.com/FXIhub/hummingbird.git + +And then use `pip` from inside the cloned directory: + +:: + + $ pip install -e . + + +**Running Hummingbird** - After a successful installation, you will be able to start `hummingbird` from anywhere on your system, e.g.: + +:: + + $ hummingbird -i + Supported Operating Systems --------------------------- @@ -10,8 +36,8 @@ Supported Operating Systems Requirements ------------ -* `Python 2.7 or 3.4 `_ -* `PyQt4, PyQt5 `_ or `PySide `_ +* `Python `_ >= 3.8 +* `PyQt5 `_ * `PyQtGraph `_ >= 0.10 * `Numpy `_ * `Scipy `_ @@ -21,34 +47,11 @@ Requirements * `h5py `_ * `h5writer `_ * `pint `_ +* `pytz `_ + Requirements for testing ------------------------ -* `subprocess32 `_ (only for python 2.7) * `pytest `_ Some of the `more advanced examples `_ require an installation of `libspimage `_ and/or `condor `_. - -Downloading the Source Code ---------------------------- - -To be able to use Hummingbird you first need to obtain the code -To do that just clone the git repository: - -:: - - $ git clone https://github.com/FXIhub/hummingbird.git - -There is no need for any other installation steps. - -Installing the requirements ---------------------------- - -The simplest way to install the requirements is to use `pip`: - -:: - - $ pip install -r requirements.txt - -After this command executes successfully, you will be able to start `hummingbird.py` -