Skip to content

Commit

Permalink
Updating tutorial with better conda instructions for Windows
Browse files Browse the repository at this point in the history
  • Loading branch information
craigmaloney committed Apr 27, 2021
1 parent ff32be0 commit a758ae4
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ make it easier to debug.
(venv)$ pip install thermostat
# if using conda (see note below - conda is distributed with Anaconda)
$ conda create --yes --name thermostat pandas
$ source activate thermostat
# Certain Windows installations may have issues with Thermostat 1.7.2. See "Windows Notes" below.
$ conda create --yes --name thermostat pip
$ conda activate thermostat
(thermostat)$ pip install thermostat
# If using pipenv (see https://github.com/pypa/pipenv)
Expand Down Expand Up @@ -84,7 +85,7 @@ Previous versions of the package are available on `github <https://github.com/EP
as `numpy` or `scipy`, we recommend installing and using the free
`Anaconda <https://www.continuum.io/downloads>`_ Python distribution by
Continuum Analytics. It contains many of the numeric and scientific
packages used by this package and has installers for Python 2.7 and 3.5 for
packages used by this package and has installers for Python 3.6 and later for
Windows, Mac OS X and Linux.

Once you have verified a correct installation, import the necessary methods
Expand Down Expand Up @@ -326,6 +327,24 @@ Not having this wrapper will cause a Runtime Error "Attempt to start a new proce

Other platforms should not be affected by this.

Notes for Windows Conda Users
-----------------------------

Thermostat 1.7.2 may have issues installing on Windows machines using pip because of issues with the Shapely wheel and numpy. If you are receiving strange behavior such as "WindowsError: [Error 126] The specified module could not be found" then please try this method to install the Thermostat module:

.. code-block:: bash
$ conda env remove --name thermostat
$ conda create --yes --name thermostat python==3.6.9
$ conda install -c conda-forge shapely pandas==0.24.2 numpy==1.19.5
$ pip install thermostat==1.7.2
.. note::

This is only recommended in cases where the Python environment has issues
running the thermostat module. If you are not having issues then we
recommend sticking with pip for installing the software.

More information
----------------

Expand Down

0 comments on commit a758ae4

Please sign in to comment.