From 856e592bc8b1861c652432e4929bab639a81e4b8 Mon Sep 17 00:00:00 2001 From: dave <dave@dtu.dk> Date: Fri, 25 Nov 2016 12:10:30 +0100 Subject: [PATCH] [WIP] simplified installation manual --- docs/install.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/docs/install.md b/docs/install.md index dfd9151c..fdf6505d 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,31 +1,37 @@ -# Installation -Detailed installation instructions, including how to install Python from scratch, -are described in the [detailed installation manual](docs/install-manual-detailed.md). +# Installation using Anaconda (Windows/Mac/Linux) -If you know what you are doing, you can install as a package as follows: +Install the necessary Python dependencies using the conda package manager: ``` -python setup.py install +conda install setuptools_scm future h5py pytables pytest nose sphinx +conda install scipy pandas matplotlib cython xlrd coverage xlwt openpyxl psutil +conda install -c https://conda.anaconda.org/conda-forge pyscaffold pytest-cov ``` -Or in development mode, install from your working directory +Now you can install ```wetb``` with ```pip```. However, we would like that +conda keeps track of the dependencies, so we'll tell ```pip``` not to check them: ``` -pip install -e ./ +pip install wetb --upgrade --no-deps ``` - -Or create a binary wheel distribution package with: +# Updating ```wetb``` using Anaconda ``` -python setup.py bdist_wheel -d dist +conda update --all +pip install wetb --upgrade --no-deps + ``` +# Installation using pip + -## Works with Python 2 and Python 3 + + +# Works with Python 2 and Python 3 This module is tested for Python 2 and 3 compatibility, and works on both Windows and Linux. Testing for Mac is on the way, but in theory it should work. @@ -44,8 +50,7 @@ in Python 2.7 by default. You can also write code that is compatible with both [issue 1](https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/issues/1)). - -## Dependencies +# Dependencies * [numpy](http://www.numpy.org/) @@ -72,7 +77,7 @@ in Python 2.7 by default. You can also write code that is compatible with both * six, [future](http://python-future.org/index.html) -## Note +# Note This project has been set up using PyScaffold 2.5. For details and usage information on PyScaffold see http://pyscaffold.readthedocs.org/. -- GitLab