Skip to content

Commit 1a191ff

Browse files
committed
Merge branch 'dev'
2 parents 0287fdb + a2b458e commit 1a191ff

31 files changed

+627
-1212
lines changed

.gitignore

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ pip-log.txt
3535
pip-delete-this-directory.txt
3636

3737
# Doc
38-
doc/temp/
38+
doc/temp/*
39+
!doc/temp/windpowerlib.wind_farm.WindFarm.rst
40+
!doc/temp/windpowerlib.wind_turbine_cluster.WindTurbineCluster.rst
3941
.doctrees
4042
.buildinfo
4143

@@ -96,3 +98,8 @@ ENV/
9698

9799
# tests
98100
.pytest_cache
101+
102+
# oedb data dump
103+
/windpowerlib/data/turbine_data_oedb.h5
104+
/windpowerlib/data/oedb_power_coefficient_curves.csv
105+
/windpowerlib/data/oedb_power_curves.csv

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ matrix:
1414

1515
install:
1616
- pip install .
17-
- pip install coveralls sphinx nbformat pytest-cov jupyter
17+
- pip install coveralls sphinx sphinx_rtd_theme nbformat pytest-cov jupyter
1818

1919
# command to run tests
2020
script:

doc/conf.py

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,23 @@
3535
# ones.
3636
extensions = [
3737
'sphinx.ext.autodoc',
38+
'sphinx.ext.intersphinx',
39+
'sphinx.ext.extlinks', # enables external links with a key
3840
'sphinx.ext.viewcode',
3941
'sphinx.ext.imgmath',
4042
'sphinx.ext.napoleon',
4143
'sphinx.ext.autosummary',
4244
'nbsphinx'
43-
4445
]
4546

47+
autodoc_member_order = 'bysource'
48+
49+
extlinks = {'pandas':('http://pandas.pydata.org/pandas-docs/stable/reference/%s.html',
50+
'pandas.')
51+
}
52+
# Example configuration for intersphinx: refer to the Python standard library.
53+
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
54+
4655
#
4756
autoclass_content = 'both'
4857

@@ -61,7 +70,7 @@
6170
# General information about the project.
6271
project = u'windpowerlib'
6372
copyright = u'2016, oemof developer group'
64-
author = u'oemof developing group'
73+
author = u'oemof developer group'
6574

6675
import windpowerlib
6776

@@ -117,11 +126,9 @@
117126
# -- Options for HTML output ----------------------------------------------
118127
# The theme to use for HTML and HTML Help pages. See the documentation for
119128
# a list of builtin themes.
120-
on_rtd = os.environ.get('READTHEDOCS') == 'True'
121-
if on_rtd:
122-
html_theme = 'default'
123-
else:
124-
html_theme = 'bizstyle'
129+
import sphinx_rtd_theme
130+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
131+
html_theme = 'sphinx_rtd_theme'
125132

126133
# Theme options are theme-specific and customize the look and feel of a theme
127134
# further. For a list of options available for each theme, see the
@@ -285,9 +292,9 @@
285292

286293
# Bibliographic Dublin Core info.
287294
epub_title = u'windpowerlib'
288-
epub_author = u'oemof developing group'
289-
epub_publisher = u'oemof developing group'
290-
epub_copyright = u'2016, oemof developing group'
295+
epub_author = u'oemof developer group'
296+
epub_publisher = u'oemof developer group'
297+
epub_copyright = u'2016, oemof developer group'
291298

292299
# The basename for the epub file. It defaults to the project name.
293300
#epub_basename = u'pahesmf'

doc/model_description.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Wind power plants
88
The windpowerlib provides three classes for modelling wind power as wind turbines (:py:class:`~.wind_turbine.WindTurbine`),
99
wind farms (:py:class:`~.wind_farm.WindFarm`) and wind turbine clusters (:py:class:`~.wind_turbine_cluster.WindTurbineCluster`).
1010

11-
Descisptions can also be found in the sections
11+
Descriptions can also be found in the sections
1212
:ref:`wind_turbine_label`, :ref:`wind_farm_label` and :ref:`wind_turbine_cluster_label`.
1313

1414

@@ -54,10 +54,10 @@ mean wind efficiency curve.
5454
:alt: Wind efficiency curves
5555
:align: center
5656

57-
The second option of considering wake losses is applying them to power curves by reducing the power values
57+
The second option to consider wake losses is to apply them to power curves by reducing the power values
5858
by a constant or on a wind speed depending wind farm efficiency (see :py:func:`~.wake_losses_to_power_curve`).
59-
Applying the wind farm efficiency (curve) to power curves instead of to feed-in time series has the advantage that the
60-
power curves can further be aggregated to achieve turbine cluster power curves (see :py:class:`~.wind_turbine_cluster.WindTurbineCluster`).
59+
Applying the wind farm efficiency (curve) to power curves instead of feed-in time series has the advantage that the
60+
power curves can further be aggregated to obtain turbine cluster power curves (see :py:class:`~.wind_turbine_cluster.WindTurbineCluster`).
6161

6262
Smoothing of power curves
6363
=========================

0 commit comments

Comments
 (0)