scottk/oopt-gnpy
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/oopt-gnpy.git synced 2025-11-02 02:57:52 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

docs: Fix all sphinx warnings

Browse Source 
...and also enforce a warning-free build within the CI.

Change-Id: Ia406a0a1ca2e89ceaa0288ae82128fa9427fe066
This commit is contained in:
Jan Kundrát
2020-03-25 21:08:07 +01:00
parent 094af16792
commit 5a1e3f30b3
6 changed files with 57 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
gnpy/core/utils.py
View File

@@ -29,10 +29,10 @@ def save_json(obj, filename):
def write_csv(obj, filename):
"""
convert dictionary items to a csv file
the dictionary format :
Convert dictionary items to a CSV file the dictionary format:
::
{'result category 1':
{'result category 1':
[
# 1st line of results
{'header 1' : value_xxx,
@@ -41,19 +41,21 @@ def write_csv(obj, filename):
{'header 1' : value_www,
'header 2' : value_zzz}
],
'result_category 2':
'result_category 2':
[
{},{}
]
}
}
the generated csv file will be:
result_category 1
header 1 header 2
value_xxx value_yyy
value_www value_zzz
result_category 2
...
The generated csv file will be:
::
result_category 1
header 1 header 2
value_xxx value_yyy
value_www value_zzz
result_category 2
...
"""
with open(filename, 'w', encoding='utf-8') as f:
w = writer(f)
@@ -77,12 +79,12 @@ def arrange_frequencies(length, start, stop):
"""Create an array of frequencies
:param length: number of elements
:param star: Start frequency in THz
:param start: Start frequency in THz
:param stop: Stop frequency in THz
:type length: integer
:type start: float
:type stop: float
:return an array of frequencies determined by the spacing parameter
:return: an array of frequencies determined by the spacing parameter
:rtype: numpy.ndarray
"""
return np.linspace(start, stop, length)