Skip to content

Commit 35cb07e

Browse files
authored
Update github URLs (#1177)
* Update github organization name * Update docs page url
1 parent bb9d6d7 commit 35cb07e

15 files changed

Lines changed: 74 additions & 73 deletions

File tree

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Usage question
4-
url: https://github.com/NREL/floris/discussions
4+
url: https://github.com/NatLabRockies/floris/discussions
55
about: Have any questions about using FLORIS? Post in Discussions to engage with the NLR team and FLORIS community.

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ This document provides a high-level overview of how you can get involved.
88
## Asking Questions
99

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

1515

1616
## Providing Feedback
1717

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

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

7878
We rely heavily on git and GitHub, so be sure to review the
7979
contributing guidelines in the
80-
[online documentation](https://nrel.github.io/floris/dev_guide.html).
80+
[online documentation](https://natlabrockies.github.io/floris/dev_guide.html).

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@
33
FLORIS is a controls-focused wind farm simulation software incorporating
44
steady-state engineering wake models into a performance-focused Python
55
framework. It has been in active development at NLR since 2013 and the latest
6-
release is [FLORIS v.4.6](https://github.com/NREL/floris/releases/latest).
7-
Online documentation is available at https://nrel.github.io/floris.
6+
release is [FLORIS v.4.6](https://github.com/NatLabRockies/floris/releases/latest).
7+
Online documentation is available at https://natlabrockies.github.io/floris.
88

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

1414
## WETO software
1515

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

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

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

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

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

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

114114
```python
115115
from floris import FlorisModel
@@ -123,32 +123,32 @@ fmodel.run()
123123
```
124124

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

132-
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).
132+
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).
133133
A collection of examples describing the creation of simulations as well as
134134
analysis and post processing are included in the
135-
[repository](https://github.com/NREL/floris/tree/main/examples). Examples are also listed
136-
in the [online documentation](https://nrel.github.io/floris/examples/001_opening_floris_computing_power.html).
135+
[repository](https://github.com/NatLabRockies/floris/tree/main/examples). Examples are also listed
136+
in the [online documentation](https://natlabrockies.github.io/floris/examples/001_opening_floris_computing_power.html).
137137

138138
## Engaging on GitHub
139139

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

142-
- [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
143-
- [Issues](https://github.com/NREL/floris/issues): Report potential bugs and well-developed feature requests
142+
- [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
143+
- [Issues](https://github.com/NatLabRockies/floris/issues): Report potential bugs and well-developed feature requests
144144
- [Projects](https://github.com/orgs/NREL/projects/96): Include current and future work on a timeline and assign a person to "own" it
145145

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

154154

docs/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ bibtex_bibfiles:
2424

2525
# Information about where the book exists on the web
2626
repository:
27-
url: https://github.com/NREL/floris
27+
url: https://github.com/NatLabRockies/floris
2828
path_to_book: docs
2929
branch: main
3030

docs/dev_guide.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ FLORIS is maintained by NLR.
44
We are excited about community contribution, and this page outlines
55
processes and procedures to follow when contributing to the
66
source code. For technical questions regarding FLORIS usage, please
7-
post your questions to [GitHub Discussions](https://github.com/NREL/floris/discussions).
7+
post your questions to [GitHub Discussions](https://github.com/NatLabRockies/floris/discussions).
88

99
## Getting Started
1010

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

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

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

102102
### isort
@@ -111,7 +111,7 @@ isort <path to file>
111111
isort dir/*
112112
```
113113

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

117117
### Ruff
@@ -128,8 +128,8 @@ ruff . --fix
128128
This sets the configuration from `pyproject.toml`, applies the selected rules to Python files,
129129
and fixes errors in-place where possible.
130130
131-
Ruff was initially configured in [PR#562](https://github.com/NREL/floris/pull/562), and discussed
132-
in more detail in [D#561](https://github.com/NREL/floris/discussions/561). See the Ruff
131+
Ruff was initially configured in [PR#562](https://github.com/NatLabRockies/floris/pull/562), and discussed
132+
in more detail in [D#561](https://github.com/NatLabRockies/floris/discussions/561). See the Ruff
133133
documentation for a list of [supported rules](https://github.com/charliermarsh/ruff#supported-rules)
134134
and [available options for various rules](https://github.com/charliermarsh/ruff#reference).
135135
@@ -201,7 +201,7 @@ pytest tests/*_regression_test.py
201201
202202
### Continuous Integration
203203
204-
Continuous integration is configured with [GitHub Actions](https://github.com/nrel/floris/actions)
204+
Continuous integration is configured with [GitHub Actions](https://github.com/NatLabRockies/floris/actions)
205205
and executes all of the existing tests for every push-event. The configuration file
206206
is located at `floris/.github/workflows/continuous-integration-workflow.yaml`.
207207
@@ -245,8 +245,8 @@ Be sure to complete each step in the sequence as described.
245245
2. Update the version number and commit to the `develop`` branch
246246
with a commit message such as "Update version to vN.M".
247247
The version number must be updated in the following two files:
248-
- [floris/README.md](https://github.com/NREL/floris/blob/main/README.md)
249-
- [pyproject.toml](https://github.com/NREL/floris/blob/main/pyproject.toml)
248+
- [floris/README.md](https://github.com/NatLabRockies/floris/blob/main/README.md)
249+
- [pyproject.toml](https://github.com/NatLabRockies/floris/blob/main/pyproject.toml)
250250
Note that a `.0` version number is left off meaning that valid versions
251251
are `v3`, `v3.1`, `v3.1.1`, etc.
252252
@@ -255,10 +255,10 @@ Be sure to complete each step in the sequence as described.
255255
surprises in this regard prior to a release. However, it's a good
256256
opportunity to ensure that the documentation is up to date and there
257257
are no obvious issues.
258-
Check this by opening the documentation website at https://nrel.github.io/floris
258+
Check this by opening the documentation website at https://natlabrockies.github.io/floris
259259
and scrolling through the pages.
260260
Also, verify that the automated build process has successfully completed
261-
for the commits to `develop` in [GitHub Actions](https://github.com/NREL/floris/actions/workflows/deploy-pages.yaml).
261+
for the commits to `develop` in [GitHub Actions](https://github.com/NatLabRockies/floris/actions/workflows/deploy-pages.yaml).
262262

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

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

281281
8. Hit "Publish release".
282282

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

@@ -307,11 +307,11 @@ FLORIS framework:
307307
- Grid-points
308308
309309
Initially, it's recommended to copy an existing model as a starting point, and the
310-
[Jensen](https://github.com/NREL/floris/blob/main/floris/simulation/wake_velocity/jensen.py) and
311-
[Jimenez](https://github.com/NREL/floris/blob/main/floris/simulation/wake_deflection/jimenez.py)
310+
[Jensen](https://github.com/NatLabRockies/floris/blob/main/floris/simulation/wake_velocity/jensen.py) and
311+
[Jimenez](https://github.com/NatLabRockies/floris/blob/main/floris/simulation/wake_deflection/jimenez.py)
312312
models are good choices due to their simplicity.
313313
New models must be registered in
314-
[Wake.model_map](https://github.com/NREL/floris/blob/main/floris/simulation/wake.py#L45)
314+
[Wake.model_map](https://github.com/NatLabRockies/floris/blob/main/floris/simulation/wake.py#L45)
315315
so that they can be enabled via the input dictionary.
316316

317317
```{mermaid}
@@ -404,7 +404,7 @@ def function(
404404
```
405405
406406
Some models require a special grid and/or solver, and that mapping happens in
407-
[floris.simulation.Floris](https://github.com/NREL/floris/blob/main/floris/simulation/floris.py#L145).
407+
[floris.simulation.Floris](https://github.com/NatLabRockies/floris/blob/main/floris/simulation/floris.py#L145).
408408
Generally, a specific kind of solver requires one or a number of specific grid-types.
409409
For example, `full_flow_sequential_solver` requires either `FlowFieldGrid` or
410410
`FlowFieldPlanarGrid`.

0 commit comments

Comments
 (0)