diff --git a/README.md b/README.md index c135b50bc..f013263c2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # WISDEM® -[![Actions Status](https://github.com/WISDEM/WISDEM/workflows/CI_WISDEM/badge.svg?branch=develop)](https://github.com/WISDEM/WISDEM/actions) -[![Coverage Status](https://coveralls.io/repos/github/WISDEM/WISDEM/badge.svg?branch=develop)](https://coveralls.io/github/WISDEM/WISDEM?branch=develop) +[![Actions Status](https://github.com/NLRWindSystems/WISDEM/workflows/CI_WISDEM/badge.svg?branch=develop)](https://github.com/NLRWindSystems/WISDEM/actions) +[![Coverage Status](https://coveralls.io/repos/github/NLRWindSystems/WISDEM/badge.svg?branch=develop)](https://coveralls.io/github/NLRWindSystems/WISDEM?branch=develop) [![Documentation Status](https://readthedocs.org/projects/wisdem/badge/?version=master)](https://wisdem.readthedocs.io/en/master/?badge=master) @@ -108,7 +108,7 @@ Setup and activate the Anaconda environment from a prompt (Anaconda3 Power Shell 2. Clone the repository and enter it: ```console - git clone https://github.com/WISDEM/WISDEM.git + git clone https://github.com/NLRWindSystems/WISDEM.git cd WISDEM ``` @@ -174,4 +174,4 @@ the examples or just run the examples. Otherwise, all tests will be run. ## Feedback -For software issues please use . For functionality and theory related questions and comments please use the NWTC forum for [Systems Engineering Software Questions](https://wind.nrel.gov/forum/wind/viewtopic.php?f=34&t=1002). +For software issues please use . For functionality and theory related questions and comments please use the NWTC forum for [Systems Engineering Software Questions](https://wind.nrel.gov/forum/wind/viewtopic.php?f=34&t=1002). diff --git a/docs/examples/01_nrelcsm/tutorial.rst b/docs/examples/01_nrelcsm/tutorial.rst index c3f0f37b0..5ddbed544 100644 --- a/docs/examples/01_nrelcsm/tutorial.rst +++ b/docs/examples/01_nrelcsm/tutorial.rst @@ -52,7 +52,7 @@ The final lines highlight the mass breakdown summaries: >>> nacelle_mass [165460.38774975] kg >>> turbine_mass [442906.80408368] kg -See the full source for this example on `Github `_. +See the full source for this example on `Github `_. Turbine Component Masses and Costs Using the NREL_CSM (2015) @@ -95,7 +95,7 @@ The final screen output is: >>> turbine_cost [3543676.12253719] USD >>> turbine_cost_kW [708.73522451] USD/kW -See the full source for this example on `Github `__. +See the full source for this example on `Github `__. Turbine Component Costs Using the NREL_CSM (2015) @@ -175,7 +175,7 @@ We can also print out an exhaustive listing of the inputs and outputs to each su :start-after: # 5 --- :end-before: # 5 --- -See the full source for this example on `Github `__. +See the full source for this example on `Github `__. @@ -234,7 +234,7 @@ To store for later postprocessing, we save everything into a large csv-file. Fl :start-after: # 7 --- :end-before: # 7 --- -See the full source for this example on `Github `__. +See the full source for this example on `Github `__. .. bibliography:: ../../references.bib :filter: docname in docnames diff --git a/docs/examples/11_user_custom/tutorial.rst b/docs/examples/11_user_custom/tutorial.rst index e127a694a..c63b74bc2 100644 --- a/docs/examples/11_user_custom/tutorial.rst +++ b/docs/examples/11_user_custom/tutorial.rst @@ -3,7 +3,7 @@ 11a. User Customized Optimization Example ----------------------------- -WISDEM offers a long list of design variables, figures of merit, and constraints that users can call in their ``analysis_options.yaml``. The full list is specified in the `modeling_options.yaml `. In addition, WISDEM now offers the option to build your own optimization problem by setting any available input as a design variable and any available output as either a constraint or a figure of merit. This example 11 shows how to build your customized ``analysis_options.yaml``. +WISDEM offers a long list of design variables, figures of merit, and constraints that users can call in their ``analysis_options.yaml``. The full list is specified in the `modeling_options.yaml `. In addition, WISDEM now offers the option to build your own optimization problem by setting any available input as a design variable and any available output as either a constraint or a figure of merit. This example 11 shows how to build your customized ``analysis_options.yaml``. In this example, we start from a 5MW land-based wind turbine that was developed within the Big Adaptive Rotor project (for more details refer to https://github.com/NREL/BAR_Designs) and we ask WISDEM to optimize the rated power of the turbine to minimize the levelized value of energy (LVOE) while keeping the turbine capital cost (TCC) within certain limits. Note that the focus of this example is on the capability of WISDEM, more than on the actual problem setup. diff --git a/docs/first_steps.rst b/docs/first_steps.rst index e91a31483..0566930aa 100644 --- a/docs/first_steps.rst +++ b/docs/first_steps.rst @@ -6,11 +6,11 @@ WISDEM just needs three input files for many optimization and analysis operation +---------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ | Description | Suggested Default to Modify | Where to learn more | +===========================+===============================================================================================================================+==============================================================================+ -| Geometry of the turbine | `nrel5mw.yaml `_ | `WindIO docs `_ | +| Geometry of the turbine | `nrel5mw.yaml `_ | `WindIO docs `_ | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ -| Modeling options | `modeling_options.yaml `_ | :ref:`modeling-options` | +| Modeling options | `modeling_options.yaml `_ | :ref:`modeling-options` | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ -| Analysis options | `analysis_options.yaml `_ | :ref:`analysis-options` | +| Analysis options | `analysis_options.yaml `_ | :ref:`analysis-options` | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ There are two options to run WISDEM with these files. The first option is to use a text editor to modify files and to run WISDEM from the command line. The second option is to edit the files with a GUI and run WISDEM with the click of a button. This document will describe both of these options in turn. diff --git a/docs/how_to_write_docs.rst b/docs/how_to_write_docs.rst index 5066f7758..d2890d116 100644 --- a/docs/how_to_write_docs.rst +++ b/docs/how_to_write_docs.rst @@ -141,7 +141,7 @@ text files near seamlessly. How to request doc creation --------------------------- If you think the docs should be modified or expanded, create an issue on the GitHub documentation repository. -Do this by going to the `WISDEM repo `__ then click on Issues on the lefthand side of the page. +Do this by going to the `WISDEM repo `__ then click on Issues on the lefthand side of the page. There you can see current requests for doc additions as well as adding your own. Feel free to add any issue for any type of doc and members of the WISDEM development team can determine how to approach it. Assign someone or a few people to the issue who you think would be a good fit for that doc. diff --git a/docs/index.rst b/docs/index.rst index 3b92eed66..35c0fabb1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,13 +17,13 @@ This software is provided as-is and without warranty. There are no guarantees it Important Links --------------- -- `Source Code Repository `_ +- `Source Code Repository `_ - `OpenMDAO `_ Feedback --------------- -For software issues please use the `Github Issues Tracker `_. For functionality and theory related questions and comments please use the NWTC forum for `Systems Engineering Software Questions `_. +For software issues please use the `Github Issues Tracker `_. For functionality and theory related questions and comments please use the NWTC forum for `Systems Engineering Software Questions `_. Documentation Outline ------------------------------ diff --git a/docs/installation.rst b/docs/installation.rst index 5c8d2ad88..1edc4c945 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -72,7 +72,7 @@ Setup and activate the Anaconda environment from a prompt (Anaconda3 Power Shell .. code-block:: bash - git clone https://github.com/WISDEM/WISDEM.git + git clone https://github.com/NLRWindSystems/WISDEM.git cd WISDEM diff --git a/docs/wisdem/floatingse/execution.rst b/docs/wisdem/floatingse/execution.rst index d156ad4f2..eb8c0a091 100644 --- a/docs/wisdem/floatingse/execution.rst +++ b/docs/wisdem/floatingse/execution.rst @@ -10,7 +10,7 @@ environment, and the operational constraints, are required to evaluate the total mass, cost, and code compliance. These variables are also included in the `WindIO `_ effort or found in the `floating-specific examples -`_ +`_ for standalone execution. @@ -71,7 +71,7 @@ Examples -------- As mentioned previously `floating-specific examples -`_ +`_ examples are provided. These files are encoded with default starting configurations (from :cite:`OC3` and :cite:`OC4`, respectively), with some modifications. There is an additional spar example that also has diff --git a/docs/wisdem/floatingse/geometry.rst b/docs/wisdem/floatingse/geometry.rst index 0a13b5d41..c8f3da859 100644 --- a/docs/wisdem/floatingse/geometry.rst +++ b/docs/wisdem/floatingse/geometry.rst @@ -51,7 +51,7 @@ ones shown. Inputs: WindIO -------------- -The parameterization of the input variables in the Geometry YAML file into *FloatingSE* is documented within the larger `WindIO `_ effort. When running *FloatingSE* directly as a standalone with a python script, users are encouraged to review the `floating-specific examples `_ for syntax. +The parameterization of the input variables in the Geometry YAML file into *FloatingSE* is documented within the larger `WindIO `_ effort. When running *FloatingSE* directly as a standalone with a python script, users are encouraged to review the `floating-specific examples `_ for syntax. Tapered Cylinders (Vertical Frustums) ------------------------------------- diff --git a/pyproject.toml b/pyproject.toml index e0025a96d..06502027b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -99,7 +99,7 @@ opt = ["pyoptsparse","nlopt"] # maintainers, and where to support the project financially. The key is # what's used to render the link text on PyPI. [project.urls] # Optional -"Homepage" = "https://github.com/WISDEM/WISDEM" +"Homepage" = "https://github.com/NLRWindSystems/WISDEM" "Documentation" = "https://wisdem.readthedocs.io" "Project" = "https://www.nrel.gov/wind/systems-engineering.html" diff --git a/wisdem/test/test_gluecode/test_gc_modified_yaml.py b/wisdem/test/test_gluecode/test_gc_modified_yaml.py index 6c0315eed..28905e000 100644 --- a/wisdem/test/test_gluecode/test_gc_modified_yaml.py +++ b/wisdem/test/test_gluecode/test_gc_modified_yaml.py @@ -26,7 +26,7 @@ def test15MW(self): self.assertAlmostEqual(wt_opt["rotorse.blade_mass"][0], 68233.0936092383, -1) # new value: improved interpolation self.assertAlmostEqual(wt_opt["rotorse.rp.AEP"][0] * 1.0e-6, 78.17441255915259, 1) - self.assertAlmostEqual(wt_opt["financese.lcoe"][0] * 1.0e3, 74.99461559122778, 1) + self.assertAlmostEqual(wt_opt["financese.lcoe"][0] * 1.0e3, 75.16145957017352, 1) self.assertAlmostEqual(wt_opt["rotorse.rs.tip_pos.tip_deflection"][0], 25.981457969698813, 1) self.assertAlmostEqual(wt_opt["towerse.z_param"][-1], 144.386, 3) diff --git a/wisdem/test/test_gluecode/test_gc_yaml_floating.py b/wisdem/test/test_gluecode/test_gc_yaml_floating.py index 6b74f8ba8..33045155e 100644 --- a/wisdem/test/test_gluecode/test_gc_yaml_floating.py +++ b/wisdem/test/test_gluecode/test_gc_yaml_floating.py @@ -27,7 +27,7 @@ def test15MW(self): self.assertAlmostEqual(wt_opt["rotorse.rp.AEP"][0] * 1.0e-6, 77.90013659314998, 1) self.assertAlmostEqual(wt_opt["rotorse.blade_mass"][0], 68233.0936092383, -1) # new value: improved interpolation - self.assertAlmostEqual(wt_opt["financese.lcoe"][0] * 1.0e3, 85.58193678481872, 1) + self.assertAlmostEqual(wt_opt["financese.lcoe"][0] * 1.0e3, 85.75842596244347, 1) self.assertAlmostEqual(wt_opt["rotorse.rs.tip_pos.tip_deflection"][0], 25.981457969698813, 1) diff --git a/wisdem/test/test_gluecode/test_gluecode.py b/wisdem/test/test_gluecode/test_gluecode.py index ab89517eb..9c08ed5ce 100644 --- a/wisdem/test/test_gluecode/test_gluecode.py +++ b/wisdem/test/test_gluecode/test_gluecode.py @@ -37,7 +37,7 @@ def test15MW(self): self.assertAlmostEqual(wt_opt["rotorse.rp.AEP"][0] * 1.0e-6, 77.90013659314998, 1) self.assertAlmostEqual(wt_opt["rotorse.blade_mass"][0], 68233.0936092383, -1) # new value: improved interpolation - self.assertAlmostEqual(wt_opt["financese.lcoe"][0] * 1.0e3, 75.25866160620044, 1) + self.assertAlmostEqual(wt_opt["financese.lcoe"][0] * 1.0e3, 75.42609302048847, 1) self.assertAlmostEqual(wt_opt["rotorse.rs.tip_pos.tip_deflection"][0], 25.98145796253223, 1) self.assertAlmostEqual(wt_opt["towerse.z_param"][-1], 144.386, 3)