foxes 0.8.2__tar.gz → 1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (329) hide show
  1. {foxes-0.8.2 → foxes-1.0}/MANIFEST.in +0 -1
  2. {foxes-0.8.2/foxes.egg-info → foxes-1.0}/PKG-INFO +60 -22
  3. {foxes-0.8.2 → foxes-1.0}/README.md +5 -1
  4. foxes-1.0/docs/source/conf.py +353 -0
  5. foxes-1.0/examples/abl_states/run.py +160 -0
  6. foxes-1.0/examples/compare_rotors_pwakes/run.py +217 -0
  7. foxes-1.0/examples/compare_wakes/run.py +241 -0
  8. foxes-1.0/examples/dyn_wakes/run.py +311 -0
  9. foxes-1.0/examples/field_data_nc/run.py +121 -0
  10. foxes-1.0/examples/induction_RHB/run.py +201 -0
  11. foxes-1.0/examples/multi_height/run.py +113 -0
  12. foxes-1.0/examples/power_mask/run.py +249 -0
  13. foxes-1.0/examples/random_timeseries/run.py +210 -0
  14. foxes-1.0/examples/scan_row/run.py +193 -0
  15. foxes-1.0/examples/sector_management/run.py +162 -0
  16. foxes-1.0/examples/sequential/run.py +209 -0
  17. foxes-1.0/examples/single_state/run.py +201 -0
  18. foxes-1.0/examples/states_lookup_table/run.py +137 -0
  19. foxes-1.0/examples/streamline_wakes/run.py +138 -0
  20. foxes-1.0/examples/tab_file/run.py +142 -0
  21. foxes-1.0/examples/timelines/run.py +267 -0
  22. foxes-1.0/examples/timeseries/run.py +183 -0
  23. foxes-1.0/examples/timeseries_slurm/run.py +185 -0
  24. foxes-1.0/examples/wind_rose/run.py +141 -0
  25. foxes-1.0/examples/windio/run.py +29 -0
  26. foxes-1.0/examples/yawed_wake/run.py +196 -0
  27. {foxes-0.8.2 → foxes-1.0}/foxes/__init__.py +4 -8
  28. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/__init__.py +1 -1
  29. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/downwind/downwind.py +232 -101
  30. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/downwind/models/farm_wakes_calc.py +11 -6
  31. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/downwind/models/init_farm_data.py +1 -1
  32. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/downwind/models/point_wakes_calc.py +5 -6
  33. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/downwind/models/reorder_farm_output.py +0 -1
  34. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/downwind/models/set_amb_point_results.py +4 -2
  35. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/iterative/iterative.py +73 -33
  36. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/iterative/models/farm_wakes_calc.py +11 -6
  37. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/sequential/models/plugin.py +1 -1
  38. foxes-1.0/foxes/algorithms/sequential/sequential.py +450 -0
  39. {foxes-0.8.2 → foxes-1.0}/foxes/constants.py +17 -2
  40. {foxes-0.8.2 → foxes-1.0}/foxes/core/__init__.py +1 -0
  41. foxes-1.0/foxes/core/algorithm.py +935 -0
  42. {foxes-0.8.2 → foxes-1.0}/foxes/core/data.py +252 -20
  43. foxes-1.0/foxes/core/data_calc_model.py +60 -0
  44. foxes-1.0/foxes/core/engine.py +630 -0
  45. {foxes-0.8.2 → foxes-1.0}/foxes/core/farm_controller.py +37 -9
  46. {foxes-0.8.2 → foxes-1.0}/foxes/core/farm_data_model.py +15 -0
  47. {foxes-0.8.2 → foxes-1.0}/foxes/core/model.py +133 -80
  48. {foxes-0.8.2 → foxes-1.0}/foxes/core/point_data_model.py +15 -0
  49. {foxes-0.8.2 → foxes-1.0}/foxes/core/rotor_model.py +27 -21
  50. {foxes-0.8.2 → foxes-1.0}/foxes/core/states.py +16 -0
  51. {foxes-0.8.2 → foxes-1.0}/foxes/core/turbine_type.py +28 -0
  52. {foxes-0.8.2 → foxes-1.0}/foxes/core/wake_frame.py +22 -4
  53. {foxes-0.8.2 → foxes-1.0}/foxes/core/wake_model.py +2 -3
  54. {foxes-0.8.2 → foxes-1.0}/foxes/data/windio/windio_5turbines_timeseries.yaml +23 -1
  55. foxes-1.0/foxes/engines/__init__.py +16 -0
  56. foxes-1.0/foxes/engines/dask.py +975 -0
  57. foxes-1.0/foxes/engines/default.py +75 -0
  58. foxes-1.0/foxes/engines/futures.py +72 -0
  59. foxes-1.0/foxes/engines/mpi.py +38 -0
  60. foxes-1.0/foxes/engines/multiprocess.py +74 -0
  61. foxes-1.0/foxes/engines/numpy.py +185 -0
  62. foxes-1.0/foxes/engines/pool.py +263 -0
  63. foxes-1.0/foxes/engines/single.py +139 -0
  64. {foxes-0.8.2 → foxes-1.0}/foxes/input/farm_layout/__init__.py +1 -0
  65. {foxes-0.8.2 → foxes-1.0}/foxes/input/farm_layout/from_csv.py +4 -0
  66. {foxes-0.8.2 → foxes-1.0}/foxes/input/farm_layout/from_json.py +1 -1
  67. {foxes-0.8.2 → foxes-1.0}/foxes/input/farm_layout/grid.py +2 -2
  68. foxes-1.0/foxes/input/farm_layout/ring.py +65 -0
  69. {foxes-0.8.2 → foxes-1.0}/foxes/input/farm_layout/row.py +2 -2
  70. {foxes-0.8.2 → foxes-1.0}/foxes/input/states/__init__.py +6 -0
  71. {foxes-0.8.2 → foxes-1.0}/foxes/input/states/create/random_abl_states.py +1 -1
  72. {foxes-0.8.2 → foxes-1.0}/foxes/input/states/field_data_nc.py +157 -32
  73. {foxes-0.8.2 → foxes-1.0}/foxes/input/states/multi_height.py +127 -13
  74. foxes-1.0/foxes/input/states/one_point_flow.py +577 -0
  75. {foxes-0.8.2 → foxes-1.0}/foxes/input/states/scan_ws.py +73 -2
  76. {foxes-0.8.2 → foxes-1.0}/foxes/input/states/states_table.py +204 -35
  77. {foxes-0.8.2 → foxes-1.0}/foxes/input/windio/__init__.py +1 -1
  78. {foxes-0.8.2 → foxes-1.0}/foxes/input/windio/get_states.py +44 -23
  79. {foxes-0.8.2 → foxes-1.0}/foxes/input/windio/read_attributes.py +41 -16
  80. foxes-1.0/foxes/input/windio/read_farm.py +177 -0
  81. {foxes-0.8.2 → foxes-1.0}/foxes/input/windio/read_fields.py +13 -6
  82. {foxes-0.8.2 → foxes-1.0}/foxes/input/windio/read_outputs.py +63 -22
  83. {foxes-0.8.2 → foxes-1.0}/foxes/input/windio/runner.py +31 -17
  84. {foxes-0.8.2 → foxes-1.0}/foxes/input/windio/windio.py +36 -22
  85. {foxes-0.8.2 → foxes-1.0}/foxes/models/ground_models/wake_mirror.py +8 -4
  86. {foxes-0.8.2 → foxes-1.0}/foxes/models/model_book.py +29 -18
  87. {foxes-0.8.2 → foxes-1.0}/foxes/models/partial_wakes/rotor_points.py +3 -3
  88. {foxes-0.8.2 → foxes-1.0}/foxes/models/rotor_models/centre.py +4 -0
  89. {foxes-0.8.2 → foxes-1.0}/foxes/models/rotor_models/grid.py +22 -23
  90. {foxes-0.8.2 → foxes-1.0}/foxes/models/rotor_models/levels.py +4 -5
  91. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/calculator.py +0 -2
  92. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/lookup_table.py +27 -2
  93. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/rotor_centre_calc.py +4 -3
  94. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/set_farm_vars.py +103 -34
  95. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_types/PCt_file.py +24 -0
  96. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_types/PCt_from_two.py +24 -0
  97. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_types/__init__.py +1 -0
  98. foxes-1.0/foxes/models/turbine_types/lookup.py +316 -0
  99. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_types/null_type.py +50 -0
  100. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_types/wsrho2PCt_from_two.py +24 -0
  101. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_types/wsti2PCt_from_two.py +24 -0
  102. {foxes-0.8.2 → foxes-1.0}/foxes/models/vertical_profiles/data_profile.py +1 -1
  103. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_frames/__init__.py +1 -0
  104. foxes-1.0/foxes/models/wake_frames/dynamic_wakes.py +424 -0
  105. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_frames/farm_order.py +23 -3
  106. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_frames/rotor_wd.py +4 -2
  107. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_frames/seq_dynamic_wakes.py +56 -63
  108. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_frames/streamlines.py +19 -20
  109. foxes-1.0/foxes/models/wake_frames/timelines.py +505 -0
  110. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_frames/yawed_wakes.py +4 -1
  111. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/dist_sliced.py +1 -3
  112. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/induction/rankine_half_body.py +4 -4
  113. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/induction/rathmann.py +2 -2
  114. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/induction/self_similar.py +2 -2
  115. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/induction/vortex_sheet.py +2 -2
  116. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/ti/iec_ti.py +34 -17
  117. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/top_hat.py +1 -1
  118. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/wind/bastankhah14.py +2 -2
  119. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/wind/bastankhah16.py +8 -7
  120. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/wind/jensen.py +1 -1
  121. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/wind/turbopark.py +2 -2
  122. {foxes-0.8.2 → foxes-1.0}/foxes/output/__init__.py +4 -1
  123. {foxes-0.8.2 → foxes-1.0}/foxes/output/farm_layout.py +2 -2
  124. {foxes-0.8.2 → foxes-1.0}/foxes/output/flow_plots_2d/__init__.py +0 -1
  125. {foxes-0.8.2 → foxes-1.0}/foxes/output/flow_plots_2d/flow_plots.py +70 -30
  126. {foxes-0.8.2 → foxes-1.0}/foxes/output/grids.py +91 -21
  127. foxes-1.0/foxes/output/seq_plugins/__init__.py +2 -0
  128. {foxes-0.8.2/foxes/output/flow_plots_2d → foxes-1.0/foxes/output/seq_plugins}/seq_flow_ani_plugin.py +62 -20
  129. foxes-1.0/foxes/output/seq_plugins/seq_wake_debug_plugin.py +145 -0
  130. {foxes-0.8.2 → foxes-1.0}/foxes/output/slice_data.py +131 -111
  131. {foxes-0.8.2 → foxes-1.0}/foxes/output/state_turbine_map.py +18 -13
  132. {foxes-0.8.2 → foxes-1.0}/foxes/output/state_turbine_table.py +19 -19
  133. {foxes-0.8.2 → foxes-1.0}/foxes/utils/__init__.py +1 -1
  134. foxes-1.0/foxes/utils/dev_utils.py +42 -0
  135. {foxes-0.8.2 → foxes-1.0}/foxes/utils/dict.py +1 -1
  136. {foxes-0.8.2 → foxes-1.0}/foxes/utils/factory.py +147 -52
  137. {foxes-0.8.2 → foxes-1.0}/foxes/utils/pandas_helpers.py +4 -3
  138. {foxes-0.8.2 → foxes-1.0}/foxes/utils/wind_dir.py +0 -2
  139. foxes-1.0/foxes/utils/xarray_utils.py +49 -0
  140. {foxes-0.8.2 → foxes-1.0}/foxes/variables.py +37 -0
  141. {foxes-0.8.2 → foxes-1.0/foxes.egg-info}/PKG-INFO +60 -22
  142. {foxes-0.8.2 → foxes-1.0}/foxes.egg-info/SOURCES.txt +66 -8
  143. {foxes-0.8.2 → foxes-1.0}/foxes.egg-info/requires.txt +27 -14
  144. foxes-1.0/foxes.egg-info/top_level.txt +5 -0
  145. foxes-1.0/pyproject.toml +105 -0
  146. foxes-1.0/setup.cfg +4 -0
  147. foxes-1.0/tests/0_consistency/iterative/test_iterative.py +92 -0
  148. foxes-1.0/tests/0_consistency/partial_wakes/test_partial_wakes.py +90 -0
  149. foxes-1.0/tests/1_verification/flappy_0_6/PCt_files/flappy/run.py +85 -0
  150. foxes-1.0/tests/1_verification/flappy_0_6/PCt_files/test_PCt_files.py +103 -0
  151. foxes-1.0/tests/1_verification/flappy_0_6/abl_states/flappy/run.py +85 -0
  152. foxes-1.0/tests/1_verification/flappy_0_6/abl_states/test_abl_states.py +87 -0
  153. foxes-1.0/tests/1_verification/flappy_0_6/partial_top_hat/flappy/run.py +82 -0
  154. foxes-1.0/tests/1_verification/flappy_0_6/partial_top_hat/test_partial_top_hat.py +82 -0
  155. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_linear_centre/flappy/run.py +92 -0
  156. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_linear_centre/test_row_Jensen_linear_centre.py +93 -0
  157. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_linear_tophat/flappy/run.py +92 -0
  158. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_linear_tophat/test_row_Jensen_linear_tophat.py +96 -0
  159. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_linear_tophat_IECTI2005/flappy/run.py +94 -0
  160. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_linear_tophat_IECTI2005/test_row_Jensen_linear_tophat_IECTI_2005.py +122 -0
  161. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_linear_tophat_IECTI2019/flappy/run.py +94 -0
  162. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_linear_tophat_IECTI2019/test_row_Jensen_linear_tophat_IECTI_2019.py +122 -0
  163. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_quadratic_centre/flappy/run.py +92 -0
  164. foxes-1.0/tests/1_verification/flappy_0_6/row_Jensen_quadratic_centre/test_row_Jensen_quadratic_centre.py +93 -0
  165. foxes-1.0/tests/1_verification/flappy_0_6_2/grid_rotors/flappy/run.py +85 -0
  166. foxes-1.0/tests/1_verification/flappy_0_6_2/grid_rotors/test_grid_rotors.py +130 -0
  167. foxes-1.0/tests/1_verification/flappy_0_6_2/row_Bastankhah_Crespo/flappy/run.py +96 -0
  168. foxes-1.0/tests/1_verification/flappy_0_6_2/row_Bastankhah_Crespo/test_row_Bastankhah_Crespo.py +116 -0
  169. foxes-1.0/tests/1_verification/flappy_0_6_2/row_Bastankhah_linear_centre/flappy/run.py +93 -0
  170. foxes-1.0/tests/1_verification/flappy_0_6_2/row_Bastankhah_linear_centre/test_row_Bastankhah_linear_centre.py +99 -0
  171. foxes-1.0/tests/3_examples/test_examples.py +34 -0
  172. foxes-0.8.2/foxes/VERSION +0 -1
  173. foxes-0.8.2/foxes/algorithms/sequential/sequential.py +0 -579
  174. foxes-0.8.2/foxes/core/algorithm.py +0 -450
  175. foxes-0.8.2/foxes/core/data_calc_model.py +0 -336
  176. foxes-0.8.2/foxes/input/windio/read_farm.py +0 -163
  177. foxes-0.8.2/foxes/models/wake_frames/timelines.py +0 -304
  178. foxes-0.8.2/foxes/output/flow_plots_2d.py +0 -0
  179. foxes-0.8.2/foxes/utils/runners/__init__.py +0 -1
  180. foxes-0.8.2/foxes/utils/runners/runners.py +0 -280
  181. foxes-0.8.2/foxes/utils/xarray_utils.py +0 -39
  182. foxes-0.8.2/foxes.egg-info/top_level.txt +0 -1
  183. foxes-0.8.2/foxes.egg-info/zip-safe +0 -1
  184. foxes-0.8.2/pyproject.toml +0 -6
  185. foxes-0.8.2/setup.cfg +0 -81
  186. foxes-0.8.2/setup.py +0 -4
  187. {foxes-0.8.2 → foxes-1.0}/LICENSE +0 -0
  188. {foxes-0.8.2 → foxes-1.0}/Logo_FOXES.svg +0 -0
  189. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/downwind/__init__.py +0 -0
  190. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/downwind/models/__init__.py +0 -0
  191. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/downwind/models/set_amb_farm_results.py +0 -0
  192. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/iterative/__init__.py +0 -0
  193. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/iterative/models/__init__.py +0 -0
  194. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/iterative/models/convergence.py +0 -0
  195. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/iterative/models/urelax.py +0 -0
  196. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/sequential/__init__.py +0 -0
  197. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/sequential/models/__init__.py +0 -0
  198. {foxes-0.8.2 → foxes-1.0}/foxes/algorithms/sequential/models/seq_state.py +0 -0
  199. {foxes-0.8.2 → foxes-1.0}/foxes/core/axial_induction_model.py +0 -0
  200. {foxes-0.8.2 → foxes-1.0}/foxes/core/farm_model.py +0 -0
  201. {foxes-0.8.2 → foxes-1.0}/foxes/core/ground_model.py +0 -0
  202. {foxes-0.8.2 → foxes-1.0}/foxes/core/partial_wakes_model.py +0 -0
  203. {foxes-0.8.2 → foxes-1.0}/foxes/core/turbine.py +0 -0
  204. {foxes-0.8.2 → foxes-1.0}/foxes/core/turbine_model.py +0 -0
  205. {foxes-0.8.2 → foxes-1.0}/foxes/core/vertical_profile.py +0 -0
  206. {foxes-0.8.2 → foxes-1.0}/foxes/core/wake_superposition.py +0 -0
  207. {foxes-0.8.2 → foxes-1.0}/foxes/core/wind_farm.py +0 -0
  208. {foxes-0.8.2 → foxes-1.0}/foxes/data/__init__.py +0 -0
  209. {foxes-0.8.2 → foxes-1.0}/foxes/data/farms/__init__.py +0 -0
  210. {foxes-0.8.2 → foxes-1.0}/foxes/data/farms/test_farm_67.csv +0 -0
  211. {foxes-0.8.2 → foxes-1.0}/foxes/data/parse.py +0 -0
  212. {foxes-0.8.2 → foxes-1.0}/foxes/data/power_ct_curves/DTU-10MW-D178d3-H119.csv +0 -0
  213. {foxes-0.8.2 → foxes-1.0}/foxes/data/power_ct_curves/IEA-15MW-D240-H150.csv +0 -0
  214. {foxes-0.8.2 → foxes-1.0}/foxes/data/power_ct_curves/IWT-7d5MW-D164-H100.csv +0 -0
  215. {foxes-0.8.2 → foxes-1.0}/foxes/data/power_ct_curves/NREL-5MW-D126-H90.csv +0 -0
  216. {foxes-0.8.2 → foxes-1.0}/foxes/data/power_ct_curves/__init__.py +0 -0
  217. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/WRF-Timeseries-3000.nc +0 -0
  218. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/WRF-Timeseries-4464.csv.gz +0 -0
  219. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/__init__.py +0 -0
  220. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/abl_states_6000.csv.gz +0 -0
  221. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/timeseries_100.csv.gz +0 -0
  222. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/timeseries_3000.csv.gz +0 -0
  223. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/timeseries_8000.csv.gz +0 -0
  224. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/wind_rose_bremen.csv +0 -0
  225. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/wind_rotation.nc +0 -0
  226. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/windio_timeseries_5000.nc +0 -0
  227. {foxes-0.8.2 → foxes-1.0}/foxes/data/states/winds100.tab +0 -0
  228. {foxes-0.8.2 → foxes-1.0}/foxes/data/static_data.py +0 -0
  229. {foxes-0.8.2 → foxes-1.0}/foxes/data/windio/DTU_10MW_turbine.yaml +0 -0
  230. {foxes-0.8.2 → foxes-1.0}/foxes/data/windio/__init__.py +0 -0
  231. {foxes-0.8.2 → foxes-1.0}/foxes/input/__init__.py +0 -0
  232. {foxes-0.8.2 → foxes-1.0}/foxes/input/farm_layout/from_df.py +0 -0
  233. {foxes-0.8.2 → foxes-1.0}/foxes/input/farm_layout/from_file.py +0 -0
  234. {foxes-0.8.2 → foxes-1.0}/foxes/input/farm_layout/from_random.py +0 -0
  235. {foxes-0.8.2 → foxes-1.0}/foxes/input/states/create/__init__.py +0 -0
  236. {foxes-0.8.2 → foxes-1.0}/foxes/input/states/create/random_timeseries.py +0 -0
  237. {foxes-0.8.2 → foxes-1.0}/foxes/input/states/single.py +0 -0
  238. {foxes-0.8.2 → foxes-1.0}/foxes/models/__init__.py +0 -0
  239. {foxes-0.8.2 → foxes-1.0}/foxes/models/axial_induction/__init__.py +0 -0
  240. {foxes-0.8.2 → foxes-1.0}/foxes/models/axial_induction/betz.py +0 -0
  241. {foxes-0.8.2 → foxes-1.0}/foxes/models/axial_induction/madsen.py +0 -0
  242. {foxes-0.8.2 → foxes-1.0}/foxes/models/farm_controllers/__init__.py +0 -0
  243. {foxes-0.8.2 → foxes-1.0}/foxes/models/farm_controllers/basic.py +0 -0
  244. {foxes-0.8.2 → foxes-1.0}/foxes/models/farm_models/__init__.py +0 -0
  245. {foxes-0.8.2 → foxes-1.0}/foxes/models/farm_models/turbine2farm.py +0 -0
  246. {foxes-0.8.2 → foxes-1.0}/foxes/models/ground_models/__init__.py +0 -0
  247. {foxes-0.8.2 → foxes-1.0}/foxes/models/ground_models/no_ground.py +0 -0
  248. {foxes-0.8.2 → foxes-1.0}/foxes/models/partial_wakes/__init__.py +0 -0
  249. {foxes-0.8.2 → foxes-1.0}/foxes/models/partial_wakes/axiwake.py +0 -0
  250. {foxes-0.8.2 → foxes-1.0}/foxes/models/partial_wakes/centre.py +0 -0
  251. {foxes-0.8.2 → foxes-1.0}/foxes/models/partial_wakes/grid.py +0 -0
  252. {foxes-0.8.2 → foxes-1.0}/foxes/models/partial_wakes/segregated.py +0 -0
  253. {foxes-0.8.2 → foxes-1.0}/foxes/models/partial_wakes/top_hat.py +0 -0
  254. {foxes-0.8.2 → foxes-1.0}/foxes/models/point_models/__init__.py +0 -0
  255. {foxes-0.8.2 → foxes-1.0}/foxes/models/point_models/set_uniform_data.py +0 -0
  256. {foxes-0.8.2 → foxes-1.0}/foxes/models/point_models/tke2ti.py +0 -0
  257. {foxes-0.8.2 → foxes-1.0}/foxes/models/point_models/wake_deltas.py +0 -0
  258. {foxes-0.8.2 → foxes-1.0}/foxes/models/rotor_models/__init__.py +0 -0
  259. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/__init__.py +0 -0
  260. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/kTI_model.py +0 -0
  261. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/power_mask.py +0 -0
  262. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/sector_management.py +0 -0
  263. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/table_factors.py +0 -0
  264. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/thrust2ct.py +0 -0
  265. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/yaw2yawm.py +0 -0
  266. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_models/yawm2yaw.py +0 -0
  267. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_types/CpCt_file.py +0 -0
  268. {foxes-0.8.2 → foxes-1.0}/foxes/models/turbine_types/CpCt_from_two.py +0 -0
  269. {foxes-0.8.2 → foxes-1.0}/foxes/models/vertical_profiles/__init__.py +0 -0
  270. {foxes-0.8.2 → foxes-1.0}/foxes/models/vertical_profiles/abl_log_neutral_ws.py +0 -0
  271. {foxes-0.8.2 → foxes-1.0}/foxes/models/vertical_profiles/abl_log_stable_ws.py +0 -0
  272. {foxes-0.8.2 → foxes-1.0}/foxes/models/vertical_profiles/abl_log_unstable_ws.py +0 -0
  273. {foxes-0.8.2 → foxes-1.0}/foxes/models/vertical_profiles/abl_log_ws.py +0 -0
  274. {foxes-0.8.2 → foxes-1.0}/foxes/models/vertical_profiles/sheared_ws.py +0 -0
  275. {foxes-0.8.2 → foxes-1.0}/foxes/models/vertical_profiles/uniform.py +0 -0
  276. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/__init__.py +0 -0
  277. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/axisymmetric.py +0 -0
  278. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/gaussian.py +0 -0
  279. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/induction/__init__.py +0 -0
  280. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/induction/self_similar2020.py +0 -0
  281. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/ti/__init__.py +0 -0
  282. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/ti/crespo_hernandez.py +0 -0
  283. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_models/wind/__init__.py +0 -0
  284. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/__init__.py +0 -0
  285. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/ti_linear.py +0 -0
  286. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/ti_max.py +0 -0
  287. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/ti_pow.py +0 -0
  288. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/ti_quadratic.py +0 -0
  289. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/ws_linear.py +0 -0
  290. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/ws_max.py +0 -0
  291. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/ws_pow.py +0 -0
  292. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/ws_product.py +0 -0
  293. {foxes-0.8.2 → foxes-1.0}/foxes/models/wake_superpositions/ws_quadratic.py +0 -0
  294. {foxes-0.8.2 → foxes-1.0}/foxes/output/animation.py +0 -0
  295. {foxes-0.8.2 → foxes-1.0}/foxes/output/calc_points.py +0 -0
  296. {foxes-0.8.2 → foxes-1.0}/foxes/output/farm_results_eval.py +0 -0
  297. {foxes-0.8.2 → foxes-1.0}/foxes/output/flow_plots_2d/get_fig.py +0 -0
  298. {foxes-0.8.2 → foxes-1.0}/foxes/output/output.py +0 -0
  299. {foxes-0.8.2 → foxes-1.0}/foxes/output/results_writer.py +0 -0
  300. {foxes-0.8.2 → foxes-1.0}/foxes/output/rose_plot.py +0 -0
  301. {foxes-0.8.2 → foxes-1.0}/foxes/output/rotor_point_plots.py +0 -0
  302. {foxes-0.8.2 → foxes-1.0}/foxes/output/round.py +0 -0
  303. {foxes-0.8.2 → foxes-1.0}/foxes/output/turbine_type_curves.py +0 -0
  304. {foxes-0.8.2 → foxes-1.0}/foxes/utils/abl/__init__.py +0 -0
  305. {foxes-0.8.2 → foxes-1.0}/foxes/utils/abl/neutral.py +0 -0
  306. {foxes-0.8.2 → foxes-1.0}/foxes/utils/abl/sheared.py +0 -0
  307. {foxes-0.8.2 → foxes-1.0}/foxes/utils/abl/stable.py +0 -0
  308. {foxes-0.8.2 → foxes-1.0}/foxes/utils/abl/unstable.py +0 -0
  309. {foxes-0.8.2 → foxes-1.0}/foxes/utils/cubic_roots.py +0 -0
  310. {foxes-0.8.2 → foxes-1.0}/foxes/utils/data_book.py +0 -0
  311. {foxes-0.8.2 → foxes-1.0}/foxes/utils/exec_python.py +0 -0
  312. {foxes-0.8.2 → foxes-1.0}/foxes/utils/geom2d/__init__.py +0 -0
  313. {foxes-0.8.2 → foxes-1.0}/foxes/utils/geom2d/area_geometry.py +0 -0
  314. {foxes-0.8.2 → foxes-1.0}/foxes/utils/geom2d/circle.py +0 -0
  315. {foxes-0.8.2 → foxes-1.0}/foxes/utils/geom2d/example_intersection.py +0 -0
  316. {foxes-0.8.2 → foxes-1.0}/foxes/utils/geom2d/example_union.py +0 -0
  317. {foxes-0.8.2 → foxes-1.0}/foxes/utils/geom2d/half_plane.py +0 -0
  318. {foxes-0.8.2 → foxes-1.0}/foxes/utils/geom2d/polygon.py +0 -0
  319. {foxes-0.8.2 → foxes-1.0}/foxes/utils/geopandas_helpers.py +0 -0
  320. {foxes-0.8.2 → foxes-1.0}/foxes/utils/geopandas_utils.py +0 -0
  321. {foxes-0.8.2 → foxes-1.0}/foxes/utils/load.py +0 -0
  322. {foxes-0.8.2 → foxes-1.0}/foxes/utils/pandas_utils.py +0 -0
  323. {foxes-0.8.2 → foxes-1.0}/foxes/utils/random_xy.py +0 -0
  324. {foxes-0.8.2 → foxes-1.0}/foxes/utils/regularize.py +0 -0
  325. {foxes-0.8.2 → foxes-1.0}/foxes/utils/subclasses.py +0 -0
  326. {foxes-0.8.2 → foxes-1.0}/foxes/utils/tab_files.py +0 -0
  327. {foxes-0.8.2 → foxes-1.0}/foxes/utils/two_circles.py +0 -0
  328. {foxes-0.8.2 → foxes-1.0}/foxes/utils/windrose_plot.py +0 -0
  329. {foxes-0.8.2 → foxes-1.0}/foxes.egg-info/dependency_links.txt +0 -0
@@ -1,5 +1,4 @@
1
1
  include Logo_FOXES.svg
2
- include foxes/VERSION
3
2
  include foxes/data/power_ct_curves/*.csv
4
3
  include foxes/data/states/*.csv
5
4
  include foxes/data/states/*.csv.gz
@@ -1,13 +1,36 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: foxes
3
- Version: 0.8.2
3
+ Version: 1.0
4
4
  Summary: Farm Optimization and eXtended yield Evaluation Software
5
- Author: Fraunhofer IWES
6
- Author-email: jonas.schulte@iwes.fraunhofer.de
7
- License: MIT
8
- Project-URL: Source Code, https://github.com/FraunhoferIWES/foxes
9
- Project-URL: Bug Tracker, https://github.com/FraunhoferIWES/foxes/issues
5
+ Author: Jonas Schulte
6
+ Maintainer: Jonas Schulte
7
+ License: MIT License
8
+
9
+ Copyright (c) 2022 FraunhoferIWES
10
+
11
+ Permission is hereby granted, free of charge, to any person obtaining a copy
12
+ of this software and associated documentation files (the "Software"), to deal
13
+ in the Software without restriction, including without limitation the rights
14
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15
+ copies of the Software, and to permit persons to whom the Software is
16
+ furnished to do so, subject to the following conditions:
17
+
18
+ The above copyright notice and this permission notice shall be included in all
19
+ copies or substantial portions of the Software.
20
+
21
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27
+ SOFTWARE.
28
+
29
+ Project-URL: Homepage, https://github.com/FraunhoferIWES/foxes
10
30
  Project-URL: Documentation, https://fraunhoferiwes.github.io/foxes.docs/index.html
31
+ Project-URL: Repository, https://github.com/FraunhoferIWES/foxes.git
32
+ Project-URL: Bug Tracker, https://github.com/FraunhoferIWES/foxes/issues
33
+ Project-URL: Changelog, https://github.com/FraunhoferIWES/foxes/blob/main/CHANGELOG.md
11
34
  Keywords: Wind farm,Wake modelling,Wind farm optimization
12
35
  Classifier: Topic :: Scientific/Engineering
13
36
  Classifier: Intended Audience :: Developers
@@ -28,16 +51,34 @@ Requires-Dist: matplotlib
28
51
  Requires-Dist: numpy
29
52
  Requires-Dist: pandas
30
53
  Requires-Dist: xarray
31
- Requires-Dist: dask
32
- Requires-Dist: distributed
33
54
  Requires-Dist: scipy
34
55
  Requires-Dist: netcdf4
35
56
  Requires-Dist: windrose
36
57
  Requires-Dist: cycler
58
+ Requires-Dist: tqdm
59
+ Requires-Dist: pyyaml
37
60
  Provides-Extra: io
38
61
  Requires-Dist: windio>=1; extra == "io"
39
62
  Provides-Extra: opt
40
63
  Requires-Dist: foxes-opt; extra == "opt"
64
+ Provides-Extra: dask
65
+ Requires-Dist: dask; extra == "dask"
66
+ Requires-Dist: distributed; extra == "dask"
67
+ Requires-Dist: dask-jobqueue; extra == "dask"
68
+ Requires-Dist: setuptools; extra == "dask"
69
+ Provides-Extra: eng
70
+ Requires-Dist: multiprocess; extra == "eng"
71
+ Requires-Dist: dask; extra == "eng"
72
+ Requires-Dist: distributed; extra == "eng"
73
+ Requires-Dist: dask-jobqueue; extra == "eng"
74
+ Requires-Dist: setuptools; extra == "eng"
75
+ Requires-Dist: mpi4py; extra == "eng"
76
+ Provides-Extra: eng0
77
+ Requires-Dist: multiprocess; extra == "eng0"
78
+ Requires-Dist: dask; extra == "eng0"
79
+ Requires-Dist: distributed; extra == "eng0"
80
+ Requires-Dist: dask-jobqueue; extra == "eng0"
81
+ Requires-Dist: setuptools; extra == "eng0"
41
82
  Provides-Extra: test
42
83
  Requires-Dist: flake8; extra == "test"
43
84
  Requires-Dist: pytest; extra == "test"
@@ -49,19 +90,12 @@ Requires-Dist: ipykernel; extra == "doc"
49
90
  Requires-Dist: ipywidgets; extra == "doc"
50
91
  Requires-Dist: m2r2; extra == "doc"
51
92
  Requires-Dist: lxml_html_clean; extra == "doc"
52
- Provides-Extra: all
53
- Requires-Dist: windio>=1; extra == "all"
54
- Requires-Dist: flake8; extra == "all"
55
- Requires-Dist: pytest; extra == "all"
56
- Requires-Dist: foxes-opt; extra == "all"
57
- Requires-Dist: sphinx; extra == "all"
58
- Requires-Dist: sphinx-immaterial; extra == "all"
59
- Requires-Dist: nbsphinx; extra == "all"
60
- Requires-Dist: ipykernel; extra == "all"
61
- Requires-Dist: ipywidgets; extra == "all"
62
- Requires-Dist: m2r2; extra == "all"
63
- Requires-Dist: lxml_html_clean; extra == "all"
64
- Provides-Extra: scripts
93
+ Provides-Extra: dev
94
+ Requires-Dist: flake8; extra == "dev"
95
+ Requires-Dist: pytest; extra == "dev"
96
+ Requires-Dist: jupyter; extra == "dev"
97
+ Requires-Dist: objsize; extra == "dev"
98
+ Requires-Dist: black; extra == "dev"
65
99
 
66
100
  # Welcome to foxes
67
101
 
@@ -76,7 +110,11 @@ The software `foxes` is a modular wind farm simulation and wake modelling toolbo
76
110
  - Wake model studies, comparison and validation,
77
111
  - Wind farm simulations invoking complex model chains.
78
112
 
79
- The calculation is fully vectorized and its fast performance is owed to [dask](https://www.dask.org/). Also the parallelization on local or remote clusters is enabled via `dask`. The wind farm
113
+ The fast performance of `foxes` is owed to vectorization and parallelization,
114
+ and it is intended to be used for large wind farms and large timeseries inflow data.
115
+ The parallelization on local or remote clusters is supported, based on
116
+ [dask.distributed](https://distributed.dask.org/en/stable/).
117
+ The wind farm
80
118
  optimization capabilities invoke the [iwopy](https://github.com/FraunhoferIWES/iwopy) package which
81
119
  as well supports vectorization.
82
120
 
@@ -11,7 +11,11 @@ The software `foxes` is a modular wind farm simulation and wake modelling toolbo
11
11
  - Wake model studies, comparison and validation,
12
12
  - Wind farm simulations invoking complex model chains.
13
13
 
14
- The calculation is fully vectorized and its fast performance is owed to [dask](https://www.dask.org/). Also the parallelization on local or remote clusters is enabled via `dask`. The wind farm
14
+ The fast performance of `foxes` is owed to vectorization and parallelization,
15
+ and it is intended to be used for large wind farms and large timeseries inflow data.
16
+ The parallelization on local or remote clusters is supported, based on
17
+ [dask.distributed](https://distributed.dask.org/en/stable/).
18
+ The wind farm
15
19
  optimization capabilities invoke the [iwopy](https://github.com/FraunhoferIWES/iwopy) package which
16
20
  as well supports vectorization.
17
21
 
@@ -0,0 +1,353 @@
1
+ # -*- coding: utf-8 -*-
2
+ #
3
+ # Configuration file for the Sphinx documentation builder.
4
+ #
5
+ # This file does only contain a selection of the most common options. For a
6
+ # full list see the documentation:
7
+ # http://www.sphinx-doc.org/en/master/config
8
+
9
+ # -- Path setup --------------------------------------------------------------
10
+
11
+ # If extensions (or modules to document with autodoc) are in another directory,
12
+ # add these directories to sys.path here. If the directory is relative to the
13
+ # documentation root, use os.path.abspath to make it absolute, like shown here.
14
+ #
15
+ import os
16
+ import sys
17
+
18
+ sys.path.insert(0, os.path.abspath("../.."))
19
+
20
+ from foxes import __version__
21
+
22
+ # -- Project information -----------------------------------------------------
23
+
24
+ project = "foxes"
25
+ copyright = "2024, Fraunhofer IWES"
26
+ author = "Fraunhofer IWES"
27
+
28
+ # The short X.Y version
29
+ version = __version__
30
+ # The full version, including alpha/beta/rc tags
31
+ release = __version__
32
+
33
+
34
+ # -- General configuration ---------------------------------------------------
35
+
36
+ # If your documentation needs a minimal Sphinx version, state it here.
37
+ #
38
+ # needs_sphinx = '1.0'
39
+
40
+ # Add any Sphinx extension module names here, as strings. They can be
41
+ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
42
+ # ones.
43
+ extensions = [
44
+ "nbsphinx",
45
+ "sphinx_immaterial",
46
+ "sphinx_immaterial.apidoc.python.apigen",
47
+ "sphinx.ext.autodoc",
48
+ "sphinx.ext.autosectionlabel",
49
+ # "sphinx.ext.autosummary",
50
+ "sphinx.ext.intersphinx",
51
+ "sphinx.ext.mathjax",
52
+ # "sphinx.ext.napoleon",
53
+ "sphinx.ext.viewcode",
54
+ # "sphinx.ext.inheritance_diagram",
55
+ "sphinx.ext.doctest",
56
+ "m2r2",
57
+ ]
58
+
59
+ intersphinx_mapping = {
60
+ "python": ("https://docs.python.org/3/", None),
61
+ "numpy": ("https://docs.scipy.org/doc/numpy/", None),
62
+ "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
63
+ }
64
+
65
+ # Add any paths that contain templates here, relative to this directory.
66
+ # templates_path = ["_templates"]
67
+ # autosummary_generate = False
68
+
69
+ # The suffix(es) of source filenames.
70
+ # You can specify multiple suffix as a list of string:
71
+ #
72
+ source_suffix = [".rst", ".md"]
73
+
74
+ # The master toctree document.
75
+ master_doc = "index"
76
+
77
+ # The language for content autogenerated by Sphinx. Refer to documentation
78
+ # for a list of supported languages.
79
+ #
80
+ # This is also used if you do content translation via gettext catalogs.
81
+ # Usually you set "language" from the command line for these cases.
82
+ language = "en"
83
+
84
+ # List of patterns, relative to source directory, that match files and
85
+ # directories to ignore when looking for source files.
86
+ # This pattern also affects html_static_path and html_extra_path.
87
+ exclude_patterns = [
88
+ # ipynb checkpoints
89
+ "notebooks/.ipynb_checkpoints/*.ipynb",
90
+ "build/*",
91
+ # "_templates/*",
92
+ # DEBUG
93
+ # "examples.rst",
94
+ # "notebooks/*",
95
+ # "notebooks/layout_opt.ipynb",
96
+ # "notebooks/timelines.ipynb",
97
+ # "notebooks/heterogeneous.ipynb",
98
+ # "notebooks/timeseries.ipynb",
99
+ # "api.rst"
100
+ ]
101
+
102
+ # The name of the Pygments (syntax highlighting) style to use.
103
+ pygments_style = None
104
+
105
+ # autosummary_generate = True
106
+ napolean_use_rtype = False
107
+
108
+ # -- Options for sphinxcontrib.email ------------------------------------------
109
+ # email_automode = True
110
+
111
+
112
+ # -- Options for nbsphinx -----------------------------------------------------
113
+
114
+ # Execute notebooks before conversion: 'always', 'never', 'auto' (default)
115
+ # We execute all notebooks, exclude the slow ones using 'exclude_patterns'
116
+ nbsphinx_execute = "always"
117
+
118
+ # Use this kernel instead of the one stored in the notebook metadata:
119
+ # nbsphinx_kernel_name = 'python3'
120
+
121
+ # List of arguments to be passed to the kernel that executes the notebooks:
122
+ # nbsphinx_execute_arguments = []
123
+
124
+ # If True, the build process is continued even if an exception occurs:
125
+ # nbsphinx_allow_errors = True
126
+
127
+
128
+ # Controls when a cell will time out (defaults to 30; use -1 for no timeout):
129
+ nbsphinx_timeout = 500
130
+
131
+ # Default Pygments lexer for syntax highlighting in code cells:
132
+ # nbsphinx_codecell_lexer = 'ipython3'
133
+
134
+ # Width of input/output prompts used in CSS:
135
+ # nbsphinx_prompt_width = '8ex'
136
+
137
+ # If window is narrower than this, input/output prompts are on separate lines:
138
+ # nbsphinx_responsive_width = '700px'
139
+
140
+ # This is processed by Jinja2 and inserted before each notebook
141
+ # Fix for issue with pyplot, cf
142
+ # https://github.com/readthedocs/sphinx_rtd_theme/issues/788#issuecomment-585785027
143
+ nbsphinx_prolog = r"""
144
+ .. raw:: html
145
+
146
+ <script src='http://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.10/require.min.js'></script>
147
+ <script>require=requirejs;</script>
148
+
149
+
150
+ """
151
+
152
+ # This is processed by Jinja2 and inserted after each notebook
153
+ # nbsphinx_epilog = r"""
154
+ # """
155
+
156
+ # Input prompt for code cells. "%s" is replaced by the execution count.
157
+ nbsphinx_input_prompt = "In [%s]:"
158
+
159
+ # Output prompt for code cells. "%s" is replaced by the execution count.
160
+ nbsphinx_output_prompt = "Out[%s]:"
161
+
162
+ # Specify conversion functions for custom notebook formats:
163
+ # import jupytext
164
+ # nbsphinx_custom_formats = {
165
+ # '.Rmd': lambda s: jupytext.reads(s, '.Rmd'),
166
+ # }
167
+
168
+ # Link or path to require.js, set to empty string to disable
169
+ # nbsphinx_requirejs_path = ''
170
+
171
+ # Options for loading require.js
172
+ # nbsphinx_requirejs_options = {'async': 'async'}
173
+ mathjax3_config = {
174
+ "TeX": {"equationNumbers": {"autoNumber": "AMS", "useLabelIds": True}},
175
+ }
176
+
177
+ # Additional files needed for generating LaTeX/PDF output:
178
+ # latex_additional_files = ['references.bib']
179
+
180
+ # -- Options for autodoc ----------------------------------------------------
181
+ # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration
182
+
183
+ # Automatically extract typehints when specified and place them in
184
+ # descriptions of the relevant function/method.
185
+ autodoc_typehints = "description"
186
+
187
+ # Don't show class signature with the class' name.
188
+ autodoc_class_signature = "separated"
189
+
190
+ # -- Options for HTML output -------------------------------------------------
191
+
192
+ # The theme to use for HTML and HTML Help pages. See the documentation for
193
+ # a list of builtin themes.
194
+ #
195
+ html_theme = "sphinx_immaterial"
196
+
197
+ # html_theme = 'cloud'
198
+
199
+ # Theme options are theme-specific and customize the look and feel of a theme
200
+ # further. For a list of options available for each theme, see the
201
+ # documentation.
202
+ html_theme_options = {
203
+ # TOC options
204
+ #'navigation_depth': 2, # only show 2 levels on left sidebar
205
+ # "collapse_navigation": False, # don't allow sidebar to collapse,
206
+ "site_url": "https://fraunhoferiwes.github.io/foxes.docs/index.html",
207
+ "repo_url": "https://github.com/FraunhoferIWES/foxes",
208
+ "icon": {"repo": "fontawesome/brands/github", "edit": "material/file-edit-outline"},
209
+ "palette": {"primary": "teal"},
210
+ "toc_title_is_page_title": True,
211
+ }
212
+
213
+ # Add any paths that contain custom static files (such as style sheets) here,
214
+ # relative to this directory. They are copied after the builtin static files,
215
+ # so a file named "default.css" will overwrite the builtin "default.css".
216
+ # html_static_path = ["_static"]
217
+
218
+ # custom.css is inside one of the html_static_path folders (e.g. _static)
219
+ # html_css_files = ["custom.css"]
220
+
221
+ # Custom sidebar templates, must be a dictionary that maps document names
222
+ # to template names.
223
+ #
224
+ # The default sidebars (for documents that don't match any pattern) are
225
+ # defined by theme itself. Builtin themes are using these templates by
226
+ # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
227
+ # 'searchbox.html']``.
228
+ #
229
+ # html_sidebars = {}
230
+
231
+
232
+ # -- Options for HTMLHelp output ---------------------------------------------
233
+
234
+ # Output file base name for HTML help builder.
235
+ htmlhelp_basename = "foxesdoc"
236
+
237
+
238
+ # -- Options for LaTeX output ------------------------------------------------
239
+
240
+ latex_elements = {
241
+ # The paper size ('letterpaper' or 'a4paper').
242
+ #
243
+ # 'papersize': 'letterpaper',
244
+ # The font size ('10pt', '11pt' or '12pt').
245
+ #
246
+ # 'pointsize': '10pt',
247
+ # Additional stuff for the LaTeX preamble.
248
+ #
249
+ # 'preamble': '',
250
+ # Latex figure (float) alignment
251
+ #
252
+ # 'figure_align': 'htbp',
253
+ }
254
+
255
+ # Grouping the document tree into LaTeX files. List of tuples
256
+ # (source start file, target name, title,
257
+ # author, documentclass [howto, manual, or own class]).
258
+ latex_documents = [
259
+ (master_doc, "foxes.tex", "foxes Documentation", "Fraunhofer IWES", "manual"),
260
+ ]
261
+
262
+
263
+ # -- Options for manual page output ------------------------------------------
264
+
265
+ # One entry per manual page. List of tuples
266
+ # (source start file, name, description, authors, manual section).
267
+ man_pages = [(master_doc, "foxes", "foxes Documentation", [author], 1)]
268
+
269
+
270
+ # -- Options for Texinfo output ----------------------------------------------
271
+
272
+ # Grouping the document tree into Texinfo files. List of tuples
273
+ # (source start file, target name, title, author,
274
+ # dir menu entry, description, category)
275
+ texinfo_documents = [
276
+ (
277
+ master_doc,
278
+ "foxes",
279
+ "foxes Documentation",
280
+ author,
281
+ "foxes",
282
+ "Farm Optimization and eXtended yield Evaluation Software",
283
+ "Miscellaneous",
284
+ ),
285
+ ]
286
+
287
+
288
+ # -- Options for Epub output -------------------------------------------------
289
+
290
+ # Bibliographic Dublin Core info.
291
+ epub_title = project
292
+
293
+ # The unique identifier of the text. This can be a ISBN number
294
+ # or the project homepage.
295
+ #
296
+ # epub_identifier = ''
297
+
298
+ # A unique identification for the text.
299
+ #
300
+ # epub_uid = ''
301
+
302
+ # A list of files that should not be packed into the epub file.
303
+ epub_exclude_files = ["search.html"]
304
+
305
+ # -- python_apigen configuration -------------------------------------------------
306
+
307
+ python_apigen_modules = {
308
+ "foxes.variables": "_foxes/variables/",
309
+ "foxes.constants": "_foxes/constants/",
310
+ "foxes.algorithms": "_foxes/algorithms/",
311
+ "foxes.algorithms.downwind": "_foxes/algorithms/downwind/",
312
+ "foxes.algorithms.downwind.models": "_foxes/algorithms/downwind/models/",
313
+ "foxes.algorithms.iterative": "_foxes/algorithms/iterative/",
314
+ "foxes.algorithms.iterative.models": "_foxes/algorithms/iterative/models/",
315
+ "foxes.algorithms.sequential": "_foxes/algorithms/sequential/",
316
+ "foxes.algorithms.sequential.models": "_foxes/algorithms/sequential/models/",
317
+ "foxes.core": "_foxes/core/",
318
+ "foxes.data": "_foxes/data/",
319
+ "foxes.engines": "_foxes/engines/",
320
+ "foxes.input.farm_layout": "_foxes/input/farm_layout/",
321
+ "foxes.input.states": "_foxes/input/states/",
322
+ "foxes.input.states.create": "_foxes/input/states/create/",
323
+ "foxes.input.windio": "_foxes/input/windio/",
324
+ "foxes.output": "_foxes/output/",
325
+ "foxes.output.flow_plots_2d": "_foxes/output/flow_plots_2d/",
326
+ "foxes.output.seq_plugins": "_foxes/output/seq_plugins/",
327
+ "foxes.models": "_foxes/models/",
328
+ "foxes.models.farm_controllers": "_foxes/models/farm_controllers/",
329
+ "foxes.models.farm_models": "_foxes/models/farm_models/",
330
+ "foxes.models.partial_wakes": "_foxes/models/partial_wakes/",
331
+ "foxes.models.point_models": "_foxes/models/point_models/",
332
+ "foxes.models.rotor_models": "_foxes/models/rotor_models/",
333
+ "foxes.models.turbine_models": "_foxes/models/turbine_models/",
334
+ "foxes.models.turbine_types": "_foxes/models/turbine_types/",
335
+ "foxes.models.vertical_profiles": "_foxes/models/vertical_profiles/",
336
+ "foxes.models.axial_induction": "_foxes/models/axial_induction",
337
+ "foxes.models.ground_models": "_foxes/models/ground_models",
338
+ "foxes.models.wake_frames": "_foxes/models/wake_frames/",
339
+ "foxes.models.wake_models": "_foxes/models/wake_models/",
340
+ "foxes.models.wake_models.induction": "_foxes/models/wake_models/induction/",
341
+ "foxes.models.wake_models.wind": "_foxes/models/wake_models/wind/",
342
+ "foxes.models.wake_models.ti": "_foxes/models/wake_models/ti/",
343
+ "foxes.models.wake_superpositions": "_foxes/models/wake_superpositions/",
344
+ "foxes.utils": "_foxes/utils/",
345
+ "foxes.utils.abl": "_foxes/utils/abl",
346
+ "foxes.utils.geom2d": "_foxes/utils/geom2d/",
347
+ "foxes.utils.runners": "_foxes/utils/runners/",
348
+ "foxes.utils.two_circles": "_foxes/utils/two_circles/",
349
+ "foxes.utils.abl.neutral": "_foxes/utils/abl/neutral/",
350
+ "foxes.utils.abl.stable": "_foxes/utils/abl/stable/",
351
+ "foxes.utils.abl.unstable": "_foxes/utils/abl/unstable/",
352
+ "foxes.utils.abl.sheared": "_foxes/utils/abl/sheared/",
353
+ }
@@ -0,0 +1,160 @@
1
+ import time
2
+ import argparse
3
+
4
+ import foxes
5
+ import foxes.variables as FV
6
+
7
+ if __name__ == "__main__":
8
+ parser = argparse.ArgumentParser()
9
+ parser.add_argument(
10
+ "-l",
11
+ "--layout",
12
+ help="The wind farm layout file (path or static)",
13
+ default="test_farm_67.csv",
14
+ )
15
+ parser.add_argument(
16
+ "-s",
17
+ "--states",
18
+ help="The states input file (path or static)",
19
+ default="abl_states_6000.csv.gz",
20
+ )
21
+ parser.add_argument(
22
+ "-t",
23
+ "--turbine_file",
24
+ help="The P-ct-curve csv file (path or static)",
25
+ default="NREL-5MW-D126-H90.csv",
26
+ )
27
+ parser.add_argument("-r", "--rotor", help="The rotor model", default="level4")
28
+ parser.add_argument(
29
+ "-p", "--pwakes", help="The partial wakes models", default=None, nargs="+"
30
+ )
31
+ parser.add_argument(
32
+ "-w",
33
+ "--wakes",
34
+ help="The wake models",
35
+ default=["CrespoHernandez_quadratic_k002", "Bastankhah2016_linear_lim_k004"],
36
+ nargs="+",
37
+ )
38
+ parser.add_argument(
39
+ "-m", "--tmodels", help="The turbine models", default=[], nargs="+"
40
+ )
41
+ parser.add_argument("-e", "--engine", help="The engine", default=None)
42
+ parser.add_argument(
43
+ "-n", "--n_cpus", help="The number of cpus", default=None, type=int
44
+ )
45
+ parser.add_argument(
46
+ "-c",
47
+ "--chunksize_states",
48
+ help="The chunk size for states",
49
+ default=None,
50
+ type=int,
51
+ )
52
+ parser.add_argument(
53
+ "-C",
54
+ "--chunksize_points",
55
+ help="The chunk size for points",
56
+ default=None,
57
+ type=int,
58
+ )
59
+ parser.add_argument(
60
+ "-nf", "--nofig", help="Do not show figures", action="store_true"
61
+ )
62
+ args = parser.parse_args()
63
+
64
+ mbook = foxes.models.ModelBook()
65
+ ttype = foxes.models.turbine_types.PCtFile(args.turbine_file)
66
+ mbook.turbine_types[ttype.name] = ttype
67
+
68
+ states = foxes.input.states.StatesTable(
69
+ data_source=args.states,
70
+ output_vars=[FV.WS, FV.WD, FV.TI, FV.RHO, FV.MOL],
71
+ var2col={FV.WS: "ws", FV.WD: "wd", FV.TI: "ti", FV.MOL: "mol"},
72
+ fixed_vars={FV.RHO: 1.225, FV.Z0: 0.05, FV.H: 100.0},
73
+ profiles={FV.WS: "ABLLogWsProfile"},
74
+ )
75
+
76
+ farm = foxes.WindFarm()
77
+ foxes.input.farm_layout.add_from_file(
78
+ farm,
79
+ args.layout,
80
+ col_x="x",
81
+ col_y="y",
82
+ col_H="H",
83
+ turbine_models=args.tmodels + [ttype.name],
84
+ )
85
+
86
+ algo = foxes.algorithms.Downwind(
87
+ farm,
88
+ states,
89
+ wake_models=args.wakes,
90
+ rotor_model=args.rotor,
91
+ wake_frame="rotor_wd",
92
+ partial_wakes=args.pwakes,
93
+ mbook=mbook,
94
+ engine=args.engine,
95
+ n_procs=args.n_cpus,
96
+ chunk_size_states=args.chunksize_states,
97
+ chunk_size_points=args.chunksize_points,
98
+ )
99
+
100
+ time0 = time.time()
101
+ farm_results = algo.calc_farm()
102
+ time1 = time.time()
103
+
104
+ print("\nCalc time =", time1 - time0, "\n")
105
+
106
+ print(farm_results)
107
+
108
+ fr = farm_results.to_dataframe()
109
+ print(fr[[FV.WD, FV.H, FV.AMB_REWS, FV.REWS, FV.AMB_P, FV.P]])
110
+
111
+ o = foxes.output.FarmResultsEval(farm_results)
112
+ o = foxes.output.FarmResultsEval(farm_results)
113
+ o.add_capacity(algo)
114
+ o.add_capacity(algo, ambient=True)
115
+ o.add_efficiency()
116
+
117
+ # state-turbine results
118
+ farm_df = farm_results.to_dataframe()
119
+ print("\nFarm results data:\n")
120
+ print(
121
+ farm_df[
122
+ [
123
+ FV.X,
124
+ FV.WD,
125
+ FV.AMB_REWS,
126
+ FV.REWS,
127
+ FV.AMB_TI,
128
+ FV.TI,
129
+ FV.AMB_P,
130
+ FV.P,
131
+ FV.EFF,
132
+ ]
133
+ ]
134
+ )
135
+ print()
136
+
137
+ # results by turbine
138
+ turbine_results = o.reduce_states(
139
+ {
140
+ FV.AMB_P: "mean",
141
+ FV.P: "mean",
142
+ FV.AMB_CAP: "mean",
143
+ FV.CAP: "mean",
144
+ FV.EFF: "mean",
145
+ }
146
+ )
147
+ turbine_results[FV.AMB_YLD] = o.calc_turbine_yield(
148
+ algo=algo, annual=True, ambient=True
149
+ )
150
+ turbine_results[FV.YLD] = o.calc_turbine_yield(algo=algo, annual=True)
151
+ print("\nResults by turbine:\n")
152
+ print(turbine_results)
153
+
154
+ # power results
155
+ P0 = o.calc_mean_farm_power(ambient=True)
156
+ P = o.calc_mean_farm_power()
157
+ print(f"\nFarm power : {P/1000:.1f} MW")
158
+ print(f"Farm ambient power: {P0/1000:.1f} MW")
159
+ print(f"Farm efficiency : {o.calc_farm_efficiency():.2f}")
160
+ print(f"Annual farm yield : {turbine_results[FV.YLD].sum():.2f} GWh.")