Skip to content
Snippets Groups Projects
Commit 9287a11b authored by Jenni Rinker's avatar Jenni Rinker Committed by Mads M. Pedersen
Browse files

Docs improvement: installation + header paragraphs

parent 721505f4
No related branches found
No related tags found
1 merge request!171Docs improvement: installation + header paragraphs
Pipeline #21494 passed
...@@ -18,8 +18,7 @@ Both Python2 and Python3 are supported. ...@@ -18,8 +18,7 @@ Both Python2 and Python3 are supported.
# Installation # Installation
- [Simple user](docs/install.md) See documentation.
- [Developer/contributor](docs/developer-guide.md)
# Documentation # Documentation
......
Fatigue tools Fatigue tools
=========================== ===========================
``wetb`` includes functions to help with the calculation of fatigue
equivalent loads for turbines. The documentation is in a Jupyter
notebook format. You can download the source notebook from the
``wetb`` repository, under ``docs/source/fatigue_tools``.
.. toctree:: .. toctree::
:caption: Fatigue tools :caption: Fatigue tools
......
HAWC2 tools HAWC2 tools
=========================== ===========================
``wetb`` includes functions to help with the writing of HAWC2 input
files, also know as htc files. The documentation is in a Jupyter
notebook format. You can download the source notebooks from the
``wetb`` repository, under ``docs/source/hawc2``.
.. toctree:: .. toctree::
:caption: HAWC2 :caption: HAWC2
......
...@@ -6,9 +6,10 @@ Welcome to WETB ...@@ -6,9 +6,10 @@ Welcome to WETB
*- The Wind Energy Toolbox of DTU* *- The Wind Energy Toolbox of DTU*
**Quick Start**:: This toolbox provides Python tools intended for use in the wind
community, and especially HAWC2 users. Please see the Installation
tab on the left to install the code and get started.
pip install wetb
Source code repository (and issue tracker): Source code repository (and issue tracker):
https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox
...@@ -22,5 +23,6 @@ License: ...@@ -22,5 +23,6 @@ License:
Contents: Contents:
.. toctree:: .. toctree::
installation
fatigue_tools/fatigue fatigue_tools/fatigue
hawc2/hawc2 hawc2/hawc2
\ No newline at end of file
.. _installation:
Installation
===========================
Install C++ compilers (Windows)
--------------------------------
Your computer must have a C++ compiler installed in order to install
``wetb``. Windows users can follow the instructions on
`this page <https://wiki.python.org/moin/WindowsCompilers>`_ under
the section "14.2 standalone".
Normal user
--------------------------------
You must first have installed a C++ compiler before you can use these
commands.
We recommend using the Anaconda Python distribution for easy
installation and maintenance of Python packages.
* Install the most recent, stable version of the code::
pip install wetb
* Update an installation to the most recent version::
pip install --upgrade wetb
* Install a specific version on PyPI::
pip install wetb==0.0.21
Advanced user
--------------------------------
Clone the repository and install a local editable copy::
git clone https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox.git
cd WindEnergyToolbox
pip install -e .
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment