Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Usage question
url: https://github.com/NREL/floris/discussions
url: https://github.com/NatLabRockies/floris/discussions
about: Have any questions about using FLORIS? Post in Discussions to engage with the NLR team and FLORIS community.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ This document provides a high-level overview of how you can get involved.
## Asking Questions

Have a question? Rather than opening an issue directly, please ask questions
or post comments in [Q&A Discussions](https://github.com/NREL/floris/discussions/categories/q-a).
or post comments in [Q&A Discussions](https://github.com/NatLabRockies/floris/discussions/categories/q-a).
The NLR team or other members of the community will assist. Your well-worded
question will serve as a resource to others searching for help.


## Providing Feedback

Your comments and feedback are very welcome. Please post to
[General Discussions](https://github.com/NREL/floris/discussions/categories/general)
[General Discussions](https://github.com/NatLabRockies/floris/discussions/categories/general)
with lots of information and detail. It is beneficial to consider
how someone else will understand your comments in order to make
them most effective.
Expand Down Expand Up @@ -73,8 +73,8 @@ Please remember to do the following:

If you are interested in writing code to fix an issue or
submit a new feature, let us know in
[Ideas Discussions](https://github.com/NREL/floris/discussions/categories/ideas)!
[Ideas Discussions](https://github.com/NatLabRockies/floris/discussions/categories/ideas)!

We rely heavily on git and GitHub, so be sure to review the
contributing guidelines in the
[online documentation](https://nrel.github.io/floris/dev_guide.html).
[online documentation](https://natlabrockies.github.io/floris/dev_guide.html).
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
FLORIS is a controls-focused wind farm simulation software incorporating
steady-state engineering wake models into a performance-focused Python
framework. It has been in active development at NLR since 2013 and the latest
release is [FLORIS v.4.6](https://github.com/NREL/floris/releases/latest).
Online documentation is available at https://nrel.github.io/floris.
release is [FLORIS v.4.6](https://github.com/NatLabRockies/floris/releases/latest).
Online documentation is available at https://natlabrockies.github.io/floris.

The software is in active development and engagement with the development team
is highly encouraged. If you are interested in using FLORIS to conduct studies
of a wind farm or extending FLORIS to include your own wake model, please join
the conversation in [GitHub Discussions](https://github.com/NREL/floris/discussions/)!
the conversation in [GitHub Discussions](https://github.com/NatLabRockies/floris/discussions/)!

## WETO software

FLORIS is primarily developed with the support from the U.S. Department of Energy and
is part of the [WETO Software Stack](https://nrel.github.io/WETOStack).
is part of the [WETO Software Stack](https://natlabrockies.github.io/WETOStack).
For more information and other integrated modeling software, see:

- [Portfolio Overview](https://nrel.github.io/WETOStack/portfolio_analysis/overview.html)
- [Entry Guide](https://nrel.github.io/WETOStack/_static/entry_guide/index.html)
- [Portfolio Overview](https://natlabrockies.github.io/WETOStack/portfolio_analysis/overview.html)
- [Entry Guide](https://natlabrockies.github.io/WETOStack/_static/entry_guide/index.html)
- [Wind Farm Controls Workshop](https://www.youtube.com/watch?v=f-w6whxIBrA&list=PL6ksUtsZI1dwRXeWFCmJT6cEN1xijsHJz)

## Installation
Expand Down Expand Up @@ -46,7 +46,7 @@ commands in a terminal or shell will download and install FLORIS.

```bash
# Download the source code from the `main` branch
git clone -b main https://github.com/NREL/floris.git
git clone -b main https://github.com/NatLabRockies/floris.git

# If using conda, be sure to activate your environment prior to installing
# conda activate <env name>
Expand Down Expand Up @@ -102,14 +102,14 @@ features, improvements, and bug fixes will be issued on an ongoing basis.

FLORIS is a Python package run on the command line typically by providing
an input file with an initial configuration. It can be installed with
```pip install floris``` (see [installation](https://nrel.github.io/floris/installation.html)).
```pip install floris``` (see [installation](https://natlabrockies.github.io/floris/installation.html)).
The typical entry point is
[FlorisModel](https://nrel.github.io/floris/_autosummary/floris.floris_model.html)
[FlorisModel](https://natlabrockies.github.io/floris/_autosummary/floris.floris_model.html)
which accepts the path to the input file as an argument. From there,
changes can be made to the initial configuration through the
[FlorisModel.set](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.set)
[FlorisModel.set](https://natlabrockies.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.set)
routine, and the simulation is executed with
[FlorisModel.run](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.run).
[FlorisModel.run](https://natlabrockies.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.run).

```python
from floris import FlorisModel
Expand All @@ -123,32 +123,32 @@ fmodel.run()
```

Finally, results can be analyzed via post-processing functions available within
[FlorisModel](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel)
[FlorisModel](https://natlabrockies.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel)
such as
- [FlorisModel.get_turbine_layout](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_turbine_layout)
- [FlorisModel.get_turbine_powers](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_turbine_powers)
- [FlorisModel.get_farm_AEP](https://nrel.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_farm_AEP)
- [FlorisModel.get_turbine_layout](https://natlabrockies.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_turbine_layout)
- [FlorisModel.get_turbine_powers](https://natlabrockies.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_turbine_powers)
- [FlorisModel.get_farm_AEP](https://natlabrockies.github.io/floris/_autosummary/floris.floris_model.html#floris.floris_model.FlorisModel.get_farm_AEP)

and in two visualization packages: [layoutviz](https://nrel.github.io/floris/_autosummary/floris.layout_visualization.html) and [flowviz](https://nrel.github.io/floris/_autosummary/floris.flow_visualization.html).
and in two visualization packages: [layoutviz](https://natlabrockies.github.io/floris/_autosummary/floris.layout_visualization.html) and [flowviz](https://natlabrockies.github.io/floris/_autosummary/floris.flow_visualization.html).
A collection of examples describing the creation of simulations as well as
analysis and post processing are included in the
[repository](https://github.com/NREL/floris/tree/main/examples). Examples are also listed
in the [online documentation](https://nrel.github.io/floris/examples/001_opening_floris_computing_power.html).
[repository](https://github.com/NatLabRockies/floris/tree/main/examples). Examples are also listed
in the [online documentation](https://natlabrockies.github.io/floris/examples/001_opening_floris_computing_power.html).

## Engaging on GitHub

FLORIS leverages the following GitHub features to coordinate support and development efforts:

- [Discussions](https://github.com/NREL/floris/discussions): Collaborate to develop ideas for new use cases, features, and software designs, and get support for usage questions
- [Issues](https://github.com/NREL/floris/issues): Report potential bugs and well-developed feature requests
- [Discussions](https://github.com/NatLabRockies/floris/discussions): Collaborate to develop ideas for new use cases, features, and software designs, and get support for usage questions
- [Issues](https://github.com/NatLabRockies/floris/issues): Report potential bugs and well-developed feature requests
- [Projects](https://github.com/orgs/NREL/projects/96): Include current and future work on a timeline and assign a person to "own" it

Generally, the first entry point for the community will be within one of the
categories in Discussions.
[Ideas](https://github.com/NREL/floris/discussions/categories/ideas) is a great spot to develop the
details for a feature request. [Q&A](https://github.com/NREL/floris/discussions/categories/q-a)
[Ideas](https://github.com/NatLabRockies/floris/discussions/categories/ideas) is a great spot to develop the
details for a feature request. [Q&A](https://github.com/NatLabRockies/floris/discussions/categories/q-a)
is where to get usage support.
[Show and tell](https://github.com/NREL/floris/discussions/categories/show-and-tell) is a free-form
[Show and tell](https://github.com/NatLabRockies/floris/discussions/categories/show-and-tell) is a free-form
space to show off the things you are doing with FLORIS.


Expand Down
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ bibtex_bibfiles:

# Information about where the book exists on the web
repository:
url: https://github.com/NREL/floris
url: https://github.com/NatLabRockies/floris
path_to_book: docs
branch: main

Expand Down
42 changes: 21 additions & 21 deletions docs/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ FLORIS is maintained by NLR.
We are excited about community contribution, and this page outlines
processes and procedures to follow when contributing to the
source code. For technical questions regarding FLORIS usage, please
post your questions to [GitHub Discussions](https://github.com/NREL/floris/discussions).
post your questions to [GitHub Discussions](https://github.com/NatLabRockies/floris/discussions).

## Getting Started

Expand Down Expand Up @@ -42,11 +42,11 @@ developer's guide, so please read on to learn more about each of these steps.
## Git and GitHub Workflows

The majority of the collaboration and development for FLORIS takes place in
the [GitHub repository](http://github.com/nrel/floris). There,
[issues](http://github.com/nrel/floris/issues) and
[pull requests](http://github.com/nrel/floris/pulls) are managed,
questions and ideas are [discussed](https://github.com/NREL/floris/discussions),
and [new versions](http://github.com/nrel/floris/releases)
the [GitHub repository](http://github.com/NatLabRockies/floris). There,
[issues](http://github.com/NatLabRockies/floris/issues) and
[pull requests](http://github.com/NatLabRockies/floris/pulls) are managed,
questions and ideas are [discussed](https://github.com/NatLabRockies/floris/discussions),
and [new versions](http://github.com/NatLabRockies/floris/releases)
are released. It is the best mechanism for engaging with the NLR team
and other developers throughout the FLORIS community.

Expand Down Expand Up @@ -96,7 +96,7 @@ are likely and should be resolved as early as possible.
FLORIS is configured to use tools to automatically check and enforce
aspects of code quality. In general, these should be adopted by all
developers and incorporated into the development workflow. Most
tools are configured in [pyproject.toml](https://github.com/NREL/floris/blob/main/pyproject.toml),
tools are configured in [pyproject.toml](https://github.com/NatLabRockies/floris/blob/main/pyproject.toml),
but some may have a dedicated configuration file.

### isort
Expand All @@ -111,7 +111,7 @@ isort <path to file>
isort dir/*
```

This tool was initially configured in [PR#535](https://github.com/NREL/floris/pull/535),
This tool was initially configured in [PR#535](https://github.com/NatLabRockies/floris/pull/535),
and additional information on specific decisions can be found there.

### Ruff
Expand All @@ -128,8 +128,8 @@ ruff . --fix
This sets the configuration from `pyproject.toml`, applies the selected rules to Python files,
and fixes errors in-place where possible.

Ruff was initially configured in [PR#562](https://github.com/NREL/floris/pull/562), and discussed
in more detail in [D#561](https://github.com/NREL/floris/discussions/561). See the Ruff
Ruff was initially configured in [PR#562](https://github.com/NatLabRockies/floris/pull/562), and discussed
in more detail in [D#561](https://github.com/NatLabRockies/floris/discussions/561). See the Ruff
documentation for a list of [supported rules](https://github.com/charliermarsh/ruff#supported-rules)
and [available options for various rules](https://github.com/charliermarsh/ruff#reference).

Expand Down Expand Up @@ -201,7 +201,7 @@ pytest tests/*_regression_test.py

### Continuous Integration

Continuous integration is configured with [GitHub Actions](https://github.com/nrel/floris/actions)
Continuous integration is configured with [GitHub Actions](https://github.com/NatLabRockies/floris/actions)
and executes all of the existing tests for every push-event. The configuration file
is located at `floris/.github/workflows/continuous-integration-workflow.yaml`.

Expand Down Expand Up @@ -245,8 +245,8 @@ Be sure to complete each step in the sequence as described.
2. Update the version number and commit to the `develop`` branch
with a commit message such as "Update version to vN.M".
The version number must be updated in the following two files:
- [floris/README.md](https://github.com/NREL/floris/blob/main/README.md)
- [pyproject.toml](https://github.com/NREL/floris/blob/main/pyproject.toml)
- [floris/README.md](https://github.com/NatLabRockies/floris/blob/main/README.md)
- [pyproject.toml](https://github.com/NatLabRockies/floris/blob/main/pyproject.toml)
Note that a `.0` version number is left off meaning that valid versions
are `v3`, `v3.1`, `v3.1.1`, etc.

Expand All @@ -255,10 +255,10 @@ Be sure to complete each step in the sequence as described.
surprises in this regard prior to a release. However, it's a good
opportunity to ensure that the documentation is up to date and there
are no obvious issues.
Check this by opening the documentation website at https://nrel.github.io/floris
Check this by opening the documentation website at https://natlabrockies.github.io/floris
and scrolling through the pages.
Also, verify that the automated build process has successfully completed
for the commits to `develop` in [GitHub Actions](https://github.com/NREL/floris/actions/workflows/deploy-pages.yaml).
for the commits to `develop` in [GitHub Actions](https://github.com/NatLabRockies/floris/actions/workflows/deploy-pages.yaml).

4. The changes since the prior commit can be gotten from GitHub by going through the
process to create a release, but stopping short of actually publishing it.
Expand All @@ -270,7 +270,7 @@ Be sure to complete each step in the sequence as described.
5. Merge the pull request into `main`. Select "Create a merge commit" from the merge
dropdown, and hit "Merge pull request".

6. Create a [new release](https://github.com/NREL/floris/releases/new) on GitHub
6. Create a [new release](https://github.com/NatLabRockies/floris/releases/new) on GitHub
with the title "vN.M". Choose to create a new tag on publish with the same
name. Also, autogenerate the release notes again. If you autogenerated the release
notes in step 4, make sure to start this step from a new browser window.
Expand All @@ -280,7 +280,7 @@ Be sure to complete each step in the sequence as described.

8. Hit "Publish release".

9. Go to GitHub Actions and watch the [Upload Python Package](https://github.com/NREL/floris/actions/workflows/python-publish.yml)
9. Go to GitHub Actions and watch the [Upload Python Package](https://github.com/NatLabRockies/floris/actions/workflows/python-publish.yml)
job complete. Upon success, FLORIS will be uploaded to PyPI for installation with pip.
If it fails, the latest release will not be distributed.

Expand All @@ -307,11 +307,11 @@ FLORIS framework:
- Grid-points

Initially, it's recommended to copy an existing model as a starting point, and the
[Jensen](https://github.com/NREL/floris/blob/main/floris/simulation/wake_velocity/jensen.py) and
[Jimenez](https://github.com/NREL/floris/blob/main/floris/simulation/wake_deflection/jimenez.py)
[Jensen](https://github.com/NatLabRockies/floris/blob/main/floris/simulation/wake_velocity/jensen.py) and
[Jimenez](https://github.com/NatLabRockies/floris/blob/main/floris/simulation/wake_deflection/jimenez.py)
models are good choices due to their simplicity.
New models must be registered in
[Wake.model_map](https://github.com/NREL/floris/blob/main/floris/simulation/wake.py#L45)
[Wake.model_map](https://github.com/NatLabRockies/floris/blob/main/floris/simulation/wake.py#L45)
so that they can be enabled via the input dictionary.

```{mermaid}
Expand Down Expand Up @@ -404,7 +404,7 @@ def function(
```

Some models require a special grid and/or solver, and that mapping happens in
[floris.simulation.Floris](https://github.com/NREL/floris/blob/main/floris/simulation/floris.py#L145).
[floris.simulation.Floris](https://github.com/NatLabRockies/floris/blob/main/floris/simulation/floris.py#L145).
Generally, a specific kind of solver requires one or a number of specific grid-types.
For example, `full_flow_sequential_solver` requires either `FlowFieldGrid` or
`FlowFieldPlanarGrid`.
Expand Down
Loading