Skip to content

Commit bf4019d

Browse files
committed
Update installation instructions in README file
1 parent b360b6f commit bf4019d

File tree

1 file changed

+8
-17
lines changed

1 file changed

+8
-17
lines changed

README.rst

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,25 @@ Although **HTTomolibGPU** can be used as a stand-alone library, it has been spec
1414
its backend for data processing. HTTomo is a user interface (UI) written in Python for fast big tomographic data processing using
1515
MPI protocols or as well serially.
1616

17-
Install HTTomolibGPU as a PyPi package
18-
=========================================================
19-
.. code-block:: console
17+
Installation
18+
============
2019

21-
$ pip install httomolibgpu
20+
HTTomolibGPU is available on PyPI, but currently can only be installed into a conda environment
21+
(due to a dependency being available only through conda).
2222

23-
Install HTTomolibGPU as a pre-built conda Python package
24-
=========================================================
2523
.. code-block:: console
2624
2725
$ conda create --name httomolibgpu # create a fresh conda environment
2826
$ conda activate httomolibgpu # activate the environment
29-
$ conda install -c httomo httomolibgpu -c conda-forge # for linux users
27+
$ conda install -c ccpi -c conda-forge ccpi-regulariser cupy==12.3.0 # for linux users
28+
$ pip install httomolibgpu
3029
3130
Setup the development environment:
3231
==================================
3332

3433
.. code-block:: console
3534
3635
$ git clone [email protected]:DiamondLightSource/httomolibgpu.git # clone the repo
37-
$ conda env create --name httomolibgpu --file conda/environment.yml # install dependencies
36+
$ conda env create --name httomolibgpu -c ccpi -c conda-forge ccpi-regulariser cupy==12.3.0 # install dependencies
3837
$ conda activate httomolibgpu # activate the environment
39-
$ pip install -e .[dev] # editable/development mode
40-
41-
Build HTTomolibGPU as a conda Python package
42-
============================================
43-
44-
.. code-block:: console
45-
46-
$ conda build conda/recipe/ -c conda-forge -c httomo
47-
38+
$ pip install -e ./httomolibgpu[dev] # editable/development mode

0 commit comments

Comments
 (0)