Merge pull request #18 from rafmudaf/main

examples/plant/validation.py

@@ -1,7 +1,7 @@
 import yaml
 import os
-from utils import plant_schemas_path, plant_examples_data_path
-from utils.yml_utils import validate_yaml, XrResourceLoader
+from windIO.utils import plant_schemas_path, plant_examples_data_path
+from windIO.utils.yml_utils import validate_yaml, XrResourceLoader
 
 
 if __name__ == '__main__':

setup.py

@@ -1,15 +1,37 @@
 import setuptools
 
+# Required packages to use the library
+REQUIRED = [
+    'jsonschema',
+    'numpy',
+    'pyyaml',
+    'xarray',
+]
+
+# Optional packages
+# To use:
+#   pip install -e ".[test]"         installs testing packages in editable install
+#   pip install "windIO[test]"       installs testing packages in non-editable install
+EXTRAS = {
+    "test": {
+        'pytest',
+        'py_wake',
+        'topfarm',
+    },
+}
+
 metadata = dict(
     name="windIO",
     url='https://github.com/IEAWindTask37/windIO',
     version="1.0",
     description="Frameworks defining the inputs and outputs for systems engineering MDAO of wind turbine and plants.",
     author="IEA Wind Task 37",
-    packages=setuptools.find_packages(exclude=["test", "examples"]),
+    packages=setuptools.find_packages(exclude=["docs*", "examples*", "test*"]),
     python_requires=">=3.7",
     zip_safe=True,
-    install_requires=['jsonschema', 'numpy', 'pyyaml', 'pytest', 'xarray']
-    )
+    install_requires=REQUIRED,
+    extras_require=EXTRAS,
+    license="Apache-2.0",
+)
 
-setuptools.setup(**metadata)
+setuptools.setup(**metadata)

test/plant/test_resources_pywake.py

@@ -1,5 +1,5 @@
 
-from utils.pywake_utils import yml2Site, xr2Site
+from windIO.utils.pywake_utils import yml2Site, xr2Site
 import numpy.testing as npt
 import numpy as np
 import pytest

test/plant/test_system_pywake.py

@@ -1,6 +1,6 @@
-from utils import plant_examples_data_path
-from utils.yml_utils import load_yaml
-from utils.pywake_utils import ymlSystem2PyWake
+from windIO.utils import plant_examples_data_path
+from windIO.utils.yml_utils import load_yaml
+from windIO.utils.pywake_utils import ymlSystem2PyWake
 from py_wake.deficit_models.gaussian import IEA37SimpleBastankhahGaussian
 import numpy as np
 import numpy.testing as npt
@@ -13,7 +13,7 @@
     from topfarm.cost_models.py_wake_wrapper import PyWakeAEPCostModelComponent
     from topfarm.constraint_components.boundary import CircleBoundaryConstraint
     from topfarm.plotting import XYPlotComp
-    from utils.topfarm_utils import ymlSystem2TopFarm
+    from windIO.utils.topfarm_utils import ymlSystem2TopFarm
     from test.plant import examples_data_path
 except ModuleNotFoundError:
     topfarm = None

test/plant/test_turbine.py

@@ -1,5 +1,5 @@
-from utils.pywake_utils import yml2WindTurbines
-from utils import plant_examples_data_path
+from windIO.utils.pywake_utils import yml2WindTurbines
+from windIO.utils import plant_examples_data_path
 from py_wake.examples.data.iea37._iea37 import IEA37_WindTurbines
 import numpy.testing as npt
 import numpy as np

windIO/utils/__init__.py

@@ -0,0 +1,7 @@
+import os
+
+plant_examples_data_path = os.path.dirname(__file__) + "/../../examples/plant/"
+plant_schemas_path = os.path.dirname(__file__) + "/../../windIO/plant/"
+
+turbine_examples_data_path = os.path.dirname(__file__) + "/../../examples/turbine/"
+turbine_schemas_path = os.path.dirname(__file__) + "/../../windIO/turbine/"

utils/pywake_utils.py → windIO/utils/pywake_utils.py

@@ -1,6 +1,6 @@
 import numpy as np
 import xarray as xr
-from utils.yml_utils import load_yaml, XrResourceLoader
+from windIO.utils.yml_utils import load_yaml, XrResourceLoader
 from py_wake.wind_turbines import WindTurbine
 from py_wake.wind_turbines.power_ct_functions import CubePowerSimpleCt, PowerCtFunctions
 from py_wake.site.xrsite import XRSite

utils/topfarm_utils.py → windIO/utils/topfarm_utils.py

@@ -1,5 +1,5 @@
-from utils.pywake_utils import ymlSystem2PyWake
-from utils.yml_utils import load_yaml
+from windIO.utils.pywake_utils import ymlSystem2PyWake
+from windIO.utils.yml_utils import load_yaml
 from py_wake.deficit_models.gaussian import IEA37SimpleBastankhahGaussian
 from topfarm._topfarm import TopFarmProblem
 from topfarm.constraint_components.boundary import CircleBoundaryConstraint