Fix the deployment infrastructure (#343)

* Move version file into the src dir * Fix setuptools package search * Update version to 3.0rc4 * Move floris package to root * Update pull request template
NREL · Feb 27, 2022 · ea75bf1 · ea75bf1
1 parent 98280f1
commit ea75bf1
Show file tree

Hide file tree

Showing 77 changed files with 25 additions and 21 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,18 +1,28 @@
 
-**Complete this sentence**
-THIS PULL REQUEST __ [IS/IS NOT] __ READY TO MERGE
+<!-- Is this pull request ready to be merged? -->
+<!-- i.e. tests pass or are expected to fail; all development is finished; appropriate documentation is included. -->
+<!-- If not but opening the pull request will facilitate development, make it a "draft" pull request -->
 
 **Feature or improvement description**
-<A clear and concise description of the new code.>
+<!-- A clear and concise description of the new code. -->
 
 **Related issue, if one exists**
-<Link to a related GitHub Issue.>
+<!-- Link to a related GitHub Issue. -->
 
 **Impacted areas of the software**
-<List areas which should be impacted by this pull request. This helps to determine the verification tests.>
+<!-- List any modules or other areas which should be impacted by this pull request. This helps to determine the verification tests. -->
 
 **Additional supporting information**
-<Add any other context about the problem here.>
+<!-- Add any other context about the problem here. -->
 
 **Test results, if applicable**
-<Add the results from unit tests and regression tests here along with justification for any failing test cases.>
+<!-- Add the results from unit tests and regression tests here along with justification for any failing test cases. -->
+
+<!-- Release checklist:
+- Update the version in
+    - [ ] README.rst
+    - [ ] docs/index.rst
+    - [ ] floris/VERSION
+- [ ] Verify readthedocs builds correctly
+- [ ] Create a tag in the NREL/FLORIS repository
+-->
diff --git a/README.md b/README.md
@@ -65,7 +65,7 @@ and importing FLORIS:
         3.0rc2
 
     FILE
-        ~/floris/src/floris/__init__.py
+        ~/floris/floris/__init__.py
 ```
 
 It is important to regularly check for new updates and releases as new

diff --git a/VERSION b/VERSION
diff --git a/docs/index.md b/docs/index.md
@@ -76,7 +76,7 @@ and importing FLORIS:
         3.0rc2
 
     FILE
-        ~/floris/src/floris/__init__.py
+        ~/floris/floris/__init__.py
 ```
 
 It is important to regularly check for new updates and releases as new

diff --git a/floris/VERSION b/floris/VERSION
@@ -0,0 +1 @@
+3.0rc4
diff --git a/src/floris/__init__.py → floris/__init__.py b/src/floris/__init__.py → floris/__init__.py
@@ -14,5 +14,5 @@
 
 from pathlib import Path
 
-with open(Path(__file__).parent.parent.parent / "VERSION") as _version_file:
+with open(Path(__file__).parent / "VERSION") as _version_file:
     __version__ = _version_file.read().strip()
diff --git a/src/floris/logging_manager.py → floris/logging_manager.py b/src/floris/logging_manager.py → floris/logging_manager.py
diff --git a/src/floris/simulation/__init__.py → floris/simulation/__init__.py b/src/floris/simulation/__init__.py → floris/simulation/__init__.py
diff --git a/src/floris/simulation/base.py → floris/simulation/base.py b/src/floris/simulation/base.py → floris/simulation/base.py
diff --git a/src/floris/simulation/farm.py → floris/simulation/farm.py b/src/floris/simulation/farm.py → floris/simulation/farm.py
diff --git a/src/floris/simulation/floris.py → floris/simulation/floris.py b/src/floris/simulation/floris.py → floris/simulation/floris.py
diff --git a/src/floris/simulation/flow_field.py → floris/simulation/flow_field.py b/src/floris/simulation/flow_field.py → floris/simulation/flow_field.py
diff --git a/src/floris/simulation/grid.py → floris/simulation/grid.py b/src/floris/simulation/grid.py → floris/simulation/grid.py
diff --git a/src/floris/simulation/solver.py → floris/simulation/solver.py b/src/floris/simulation/solver.py → floris/simulation/solver.py
diff --git a/src/floris/simulation/turbine.py → floris/simulation/turbine.py b/src/floris/simulation/turbine.py → floris/simulation/turbine.py
diff --git a/src/floris/simulation/wake.py → floris/simulation/wake.py b/src/floris/simulation/wake.py → floris/simulation/wake.py
diff --git a/...s/simulation/wake_combination/__init__.py → ...s/simulation/wake_combination/__init__.py b/...s/simulation/wake_combination/__init__.py → ...s/simulation/wake_combination/__init__.py
diff --git a/...floris/simulation/wake_combination/fls.py → floris/simulation/wake_combination/fls.py b/...floris/simulation/wake_combination/fls.py → floris/simulation/wake_combination/fls.py
diff --git a/...floris/simulation/wake_combination/max.py → floris/simulation/wake_combination/max.py b/...floris/simulation/wake_combination/max.py → floris/simulation/wake_combination/max.py
diff --git a/...oris/simulation/wake_combination/sosfs.py → floris/simulation/wake_combination/sosfs.py b/...oris/simulation/wake_combination/sosfs.py → floris/simulation/wake_combination/sosfs.py
diff --git a/...is/simulation/wake_deflection/__init__.py → ...is/simulation/wake_deflection/__init__.py b/...is/simulation/wake_deflection/__init__.py → ...is/simulation/wake_deflection/__init__.py
diff --git a/...floris/simulation/wake_deflection/curl.py → floris/simulation/wake_deflection/curl.py b/...floris/simulation/wake_deflection/curl.py → floris/simulation/wake_deflection/curl.py
diff --git a/...loris/simulation/wake_deflection/gauss.py → floris/simulation/wake_deflection/gauss.py b/...loris/simulation/wake_deflection/gauss.py → floris/simulation/wake_deflection/gauss.py
diff --git a/...ris/simulation/wake_deflection/jimenez.py → floris/simulation/wake_deflection/jimenez.py b/...ris/simulation/wake_deflection/jimenez.py → floris/simulation/wake_deflection/jimenez.py
diff --git a/...is/simulation/wake_turbulence/__init__.py → ...is/simulation/wake_turbulence/__init__.py b/...is/simulation/wake_turbulence/__init__.py → ...is/simulation/wake_turbulence/__init__.py
diff --git a/...ation/wake_turbulence/crespo_hernandez.py → ...ation/wake_turbulence/crespo_hernandez.py b/...ation/wake_turbulence/crespo_hernandez.py → ...ation/wake_turbulence/crespo_hernandez.py
diff --git a/...oris/simulation/wake_velocity/__init__.py → floris/simulation/wake_velocity/__init__.py b/...oris/simulation/wake_velocity/__init__.py → floris/simulation/wake_velocity/__init__.py
diff --git a/...on/wake_velocity/cumulative_gauss_curl.py → ...on/wake_velocity/cumulative_gauss_curl.py b/...on/wake_velocity/cumulative_gauss_curl.py → ...on/wake_velocity/cumulative_gauss_curl.py
diff --git a/src/floris/simulation/wake_velocity/gauss.py → floris/simulation/wake_velocity/gauss.py b/src/floris/simulation/wake_velocity/gauss.py → floris/simulation/wake_velocity/gauss.py
diff --git a/...floris/simulation/wake_velocity/jensen.py → floris/simulation/wake_velocity/jensen.py b/...floris/simulation/wake_velocity/jensen.py → floris/simulation/wake_velocity/jensen.py
diff --git a/src/floris/tools/__init__.py → floris/tools/__init__.py b/src/floris/tools/__init__.py → floris/tools/__init__.py
diff --git a/src/floris/tools/cc_blade_utilities.py → floris/tools/cc_blade_utilities.py b/src/floris/tools/cc_blade_utilities.py → floris/tools/cc_blade_utilities.py
diff --git a/src/floris/tools/cut_plane.py → floris/tools/cut_plane.py b/src/floris/tools/cut_plane.py → floris/tools/cut_plane.py
diff --git a/src/floris/tools/energy_ratio.py → floris/tools/energy_ratio.py b/src/floris/tools/energy_ratio.py → floris/tools/energy_ratio.py
diff --git a/src/floris/tools/energy_ratio_single.py → floris/tools/energy_ratio_single.py b/src/floris/tools/energy_ratio_single.py → floris/tools/energy_ratio_single.py
diff --git a/src/floris/tools/energy_wake_loss.py → floris/tools/energy_wake_loss.py b/src/floris/tools/energy_wake_loss.py → floris/tools/energy_wake_loss.py
diff --git a/src/floris/tools/floris_interface.py → floris/tools/floris_interface.py b/src/floris/tools/floris_interface.py → floris/tools/floris_interface.py
diff --git a/src/floris/tools/flow_data.py → floris/tools/flow_data.py b/src/floris/tools/flow_data.py → floris/tools/flow_data.py
diff --git a/src/floris/tools/interface_utilities.py → floris/tools/interface_utilities.py b/src/floris/tools/interface_utilities.py → floris/tools/interface_utilities.py
diff --git a/src/floris/tools/layout_functions.py → floris/tools/layout_functions.py b/src/floris/tools/layout_functions.py → floris/tools/layout_functions.py
diff --git a/src/floris/tools/optimization/__init__.py → floris/tools/optimization/__init__.py b/src/floris/tools/optimization/__init__.py → floris/tools/optimization/__init__.py
diff --git a/...oris/tools/optimization/other/__init__.py → floris/tools/optimization/other/__init__.py b/...oris/tools/optimization/other/__init__.py → floris/tools/optimization/other/__init__.py
diff --git a/...tools/optimization/other/boundary_grid.py → ...tools/optimization/other/boundary_grid.py b/...tools/optimization/other/boundary_grid.py → ...tools/optimization/other/boundary_grid.py
diff --git a/...ools/optimization/pyoptsparse/__init__.py → ...ools/optimization/pyoptsparse/__init__.py b/...ools/optimization/pyoptsparse/__init__.py → ...ools/optimization/pyoptsparse/__init__.py
diff --git a/.../tools/optimization/pyoptsparse/layout.py → .../tools/optimization/pyoptsparse/layout.py b/.../tools/optimization/pyoptsparse/layout.py → .../tools/optimization/pyoptsparse/layout.py
diff --git a/.../optimization/pyoptsparse/optimization.py → .../optimization/pyoptsparse/optimization.py b/.../optimization/pyoptsparse/optimization.py → .../optimization/pyoptsparse/optimization.py
diff --git a/...optimization/pyoptsparse/power_density.py → ...optimization/pyoptsparse/power_density.py b/...optimization/pyoptsparse/power_density.py → ...optimization/pyoptsparse/power_density.py
diff --git a/...ris/tools/optimization/pyoptsparse/yaw.py → floris/tools/optimization/pyoptsparse/yaw.py b/...ris/tools/optimization/pyoptsparse/yaw.py → floris/tools/optimization/pyoptsparse/yaw.py
diff --git a/...oris/tools/optimization/scipy/__init__.py → floris/tools/optimization/scipy/__init__.py b/...oris/tools/optimization/scipy/__init__.py → floris/tools/optimization/scipy/__init__.py
diff --git a/...oris/tools/optimization/scipy/base_COE.py → floris/tools/optimization/scipy/base_COE.py b/...oris/tools/optimization/scipy/base_COE.py → floris/tools/optimization/scipy/base_COE.py
diff --git a/...ls/optimization/scipy/cluster_turbines.py → ...ls/optimization/scipy/cluster_turbines.py b/...ls/optimization/scipy/cluster_turbines.py → ...ls/optimization/scipy/cluster_turbines.py
diff --git a/...ation/scipy/derive_downstream_turbines.py → ...ation/scipy/derive_downstream_turbines.py b/...ation/scipy/derive_downstream_turbines.py → ...ation/scipy/derive_downstream_turbines.py
diff --git a/...floris/tools/optimization/scipy/layout.py → floris/tools/optimization/scipy/layout.py b/...floris/tools/optimization/scipy/layout.py → floris/tools/optimization/scipy/layout.py
diff --git a/...tools/optimization/scipy/layout_height.py → ...tools/optimization/scipy/layout_height.py b/...tools/optimization/scipy/layout_height.py → ...tools/optimization/scipy/layout_height.py
diff --git a/.../tools/optimization/scipy/optimization.py → .../tools/optimization/scipy/optimization.py b/.../tools/optimization/scipy/optimization.py → .../tools/optimization/scipy/optimization.py
diff --git a/...tools/optimization/scipy/power_density.py → ...tools/optimization/scipy/power_density.py b/...tools/optimization/scipy/power_density.py → ...tools/optimization/scipy/power_density.py
diff --git a/...ls/optimization/scipy/power_density_1D.py → ...ls/optimization/scipy/power_density_1D.py b/...ls/optimization/scipy/power_density_1D.py → ...ls/optimization/scipy/power_density_1D.py
diff --git a/src/floris/tools/optimization/scipy/yaw.py → floris/tools/optimization/scipy/yaw.py b/src/floris/tools/optimization/scipy/yaw.py → floris/tools/optimization/scipy/yaw.py
diff --git a/...tools/optimization/scipy/yaw_clustered.py → ...tools/optimization/scipy/yaw_clustered.py b/...tools/optimization/scipy/yaw_clustered.py → ...tools/optimization/scipy/yaw_clustered.py
diff --git a/...tools/optimization/scipy/yaw_wind_rose.py → ...tools/optimization/scipy/yaw_wind_rose.py b/...tools/optimization/scipy/yaw_wind_rose.py → ...tools/optimization/scipy/yaw_wind_rose.py
diff --git a/...mization/scipy/yaw_wind_rose_clustered.py → ...mization/scipy/yaw_wind_rose_clustered.py b/...mization/scipy/yaw_wind_rose_clustered.py → ...mization/scipy/yaw_wind_rose_clustered.py
diff --git a/...imization/scipy/yaw_wind_rose_parallel.py → ...imization/scipy/yaw_wind_rose_parallel.py b/...imization/scipy/yaw_wind_rose_parallel.py → ...imization/scipy/yaw_wind_rose_parallel.py
diff --git a/...scipy/yaw_wind_rose_parallel_clustered.py → ...scipy/yaw_wind_rose_parallel_clustered.py b/...scipy/yaw_wind_rose_parallel_clustered.py → ...scipy/yaw_wind_rose_parallel_clustered.py
diff --git a/...yaw_optimization/yaw_optimization_base.py → ...yaw_optimization/yaw_optimization_base.py b/...yaw_optimization/yaw_optimization_base.py → ...yaw_optimization/yaw_optimization_base.py
diff --git a/...aw_optimization/yaw_optimization_tools.py → ...aw_optimization/yaw_optimization_tools.py b/...aw_optimization/yaw_optimization_tools.py → ...aw_optimization/yaw_optimization_tools.py
diff --git a/...n/yaw_optimization/yaw_optimizer_scipy.py → ...n/yaw_optimization/yaw_optimizer_scipy.py b/...n/yaw_optimization/yaw_optimizer_scipy.py → ...n/yaw_optimization/yaw_optimizer_scipy.py
diff --git a/...tion/yaw_optimization/yaw_optimizer_sr.py → ...tion/yaw_optimization/yaw_optimizer_sr.py b/...tion/yaw_optimization/yaw_optimizer_sr.py → ...tion/yaw_optimization/yaw_optimizer_sr.py
diff --git a/src/floris/tools/plotting.py → floris/tools/plotting.py b/src/floris/tools/plotting.py → floris/tools/plotting.py
diff --git a/src/floris/tools/power_rose.py → floris/tools/power_rose.py b/src/floris/tools/power_rose.py → floris/tools/power_rose.py
diff --git a/src/floris/tools/rews.py → floris/tools/rews.py b/src/floris/tools/rews.py → floris/tools/rews.py
diff --git a/src/floris/tools/sowfa_utilities.py → floris/tools/sowfa_utilities.py b/src/floris/tools/sowfa_utilities.py → floris/tools/sowfa_utilities.py
diff --git a/src/floris/tools/visualization.py → floris/tools/visualization.py b/src/floris/tools/visualization.py → floris/tools/visualization.py
diff --git a/src/floris/tools/wind_rose.py → floris/tools/wind_rose.py b/src/floris/tools/wind_rose.py → floris/tools/wind_rose.py
diff --git a/src/floris/type_dec.py → floris/type_dec.py b/src/floris/type_dec.py → floris/type_dec.py
diff --git a/src/floris/utilities.py → floris/utilities.py b/src/floris/utilities.py → floris/utilities.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -56,7 +56,7 @@ known_third_party = [
     "scipy",
     "attr"
 ]
-known_first_party = ["floris", "src"]
+known_first_party = ["floris"]
 combine_as_imports = true
 force_grid_wrap = 0
 include_trailing_comma = true

diff --git a/setup.py b/setup.py
@@ -13,13 +13,7 @@
 # See https://floris.readthedocs.io for documentation
 
 
-# Note: To use the 'upload' functionality of this file, you must:
-#   $ pip install twine
-
-import io
-import os
 from pathlib import Path
-
 from setuptools import setup, find_packages
 
 
@@ -56,7 +50,7 @@
 }
 
 ROOT = Path(__file__).parent
-with open(ROOT / "VERSION") as version_file:
+with open(ROOT / "floris" / "VERSION") as version_file:
     VERSION = version_file.read().strip()
 
 setup(
@@ -69,8 +63,8 @@
     author_email=EMAIL,
     python_requires=REQUIRES_PYTHON,
     url=URL,
-    package_dir={"": "src"},
-    packages=find_packages(where="src"),
+    packages=find_packages(exclude=["tests", "*.tests", "*.tests.*", "tests.*"]),
+    package_data={'floris': ['VERSION']},
     install_requires=REQUIRED,
     extras_require=EXTRAS,
     include_package_data=True,