Skip to content

Commit

Permalink
DOC: Deduplicate install directions
Browse files Browse the repository at this point in the history
There were two install directions! One in INSTALL and the other
in docs/. Now there is only one and it is more specific about
what is needed to build on Windows.
  • Loading branch information
carterbox committed Jun 22, 2020
1 parent 79bf70d commit c35171d
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 27 deletions.
8 changes: 0 additions & 8 deletions INSTALL

This file was deleted.

25 changes: 25 additions & 0 deletions INSTALL.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Installing dependencies
=======================
To build and run TomoPy, you will need to install at least the dependencies
listed in ``envs/{platform}-{version}.yml`` plus additional dependencies based
on your platform. For example, installing requirements for building
the Python 3.6 version on Linux can be accomplished as follows::

$ conda env create -f envs/linux-36.yml [-n ENVIRONMENT]


Additional Windows Requirements
-------------------------------
The Windows VC++2017 compiler cannot be distributed through conda. You must
install it using the Windows Build Tools installer. The conda package for this
compiler merely searches for this compiler and links it to the conda
environment into which it is installed.


Building TomoPy
===============

After navigating to inside the `tomopy` directory, you can install TomoPy by
running the install script in the typical Python way::

$ python setup.py install
18 changes: 1 addition & 17 deletions doc/source/devguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,23 +34,7 @@ and ask you where you want to save it. Select a location in your
computer and feel comfortable with making modifications in the code.


Installing dependencies
=======================
To build and run TomoPy, you will need to install at least the dependencies
listed in ``envs/{platform}-{version}.yml`` plus additional dependencies based
on your build environment. For example, installing requirements for building
the Python 3.6 version on Linux can be accomplished as follows::

$ conda env create -f envs/linux-36.yml


Building TomoPy
===============

After navigating to inside the `tomopy` directory, you can install TomoPy by
running the install script in the typical Python way::

$ python setup.py install
.. include:: ../../INSTALL.rst


Running the Tests
Expand Down
11 changes: 9 additions & 2 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ and its dependencies for you.
First, you must have `Conda <https://docs.conda.io/en/latest/miniconda.html>`_
installed.

Next, install TomoPy and all its dependencies into a new Conda environment
called ``tomopy`` by running::
Next, install TomoPy and all its runtime dependencies into a new Conda
environment called ``tomopy`` by running::

$ conda create --name tomopy --channel conda-forge tomopy

Expand All @@ -36,3 +36,10 @@ containing TomoPy and run::

For some more information about using Conda, please refer to the `docs
<https://conda.io/projects/conda>`__.


Build from Source
-----------------

Please read the development guide for directions on how to build TomoPy from
the source code.

0 comments on commit c35171d

Please sign in to comment.