Skip to content

Commit da6d29a

Browse files
authored
chore: update naming (#2227)
1 parent 96337ab commit da6d29a

34 files changed

+94
-94
lines changed

.build_rtd_docs/MAINPAGE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
The documentation here is extracted from the source code by [doxygen](https://www.doxygen.nl/index.html).
44

5-
The source code repository is hosted [on GitHub](https://github.com/MODFLOW-USGS/modflow6).
5+
The source code repository is hosted [on GitHub](https://github.com/MODFLOW-ORG/modflow6).
66

77
This documentation is intended for MODFLOW 6 contributors and users of the MODFLOW 6 library/API. MODFLOW 6 usage documentation can be found [on ReadTheDocs](https://modflow6.readthedocs.io/en/latest/).

.build_rtd_docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@
203203
]
204204

205205
# html_theme_options = {
206-
# "github_url": "https://github.com/MODFLOW-USGS/modflow6",
206+
# "github_url": "https://github.com/MODFLOW-ORG/modflow6",
207207
# "use_edit_page_button": False
208208
# }
209209

.build_rtd_docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Contents:
1111
.. toctree::
1212
:maxdepth: 2
1313

14-
API Reference <https://modflow-usgs.github.io/modflow6/>
14+
API Reference <https://MODFLOW-ORG.github.io/modflow6/>
1515
_mf6run/run-time-comparison.md
1616
_mf6run/deprecations.md
1717
mf6io

.build_rtd_docs/mf6io.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Input Guide
22
-----------
33

44
The latest version of the complete MODFLOW 6 input/output guide can be found
5-
`here <https://github.com/MODFLOW-USGS/modflow6-nightly-build/releases/>`_.
5+
`here <https://github.com/MODFLOW-ORG/modflow6-nightly-build/releases/>`_.
66
This section enumerates and describes MODFLOW 6 input files.
77

88
Simulation

.doc/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
# Settings for GitHub actions integration
8383
if on_rtd:
8484
extensions.append("rtds_action")
85-
rtds_action_github_repo = "MODFLOW-USGS/modflow6"
85+
rtds_action_github_repo = "MODFLOW-ORG/modflow6"
8686
rtds_action_path = "."
8787
rtds_action_artifact_prefix = "rtd-files-for-"
8888
rtds_action_github_token = os.environ.get("GITHUB_TOKEN", None)

.github/PULL_REQUEST_TEMPLATE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Checklist of items for pull request
1010
- [ ] Formatted new and modified Fortran source files with `fprettify`
1111
- [ ] Added doxygen comments to new and modified procedures
1212
- [ ] Updated meson files, makefiles, and Visual Studio project files for new source files
13-
- [ ] Updated [definition files](/MODFLOW-USGS/modflow6/tree/develop/doc/mf6io/mf6ivar)
14-
- [ ] Updated [develop.tex](/MODFLOW-USGS/modflow6/doc/ReleaseNotes/develop.tex) with a plain-language description of the bug fix, change, feature; required for changes that may affect users
15-
- [ ] Updated [input and output guide](/MODFLOW-USGS/modflow6/doc/mf6io)
13+
- [ ] Updated [definition files](/MODFLOW-ORG/modflow6/tree/develop/doc/mf6io/mf6ivar)
14+
- [ ] Updated [develop.tex](/MODFLOW-ORG/modflow6/doc/ReleaseNotes/develop.tex) with a plain-language description of the bug fix, change, feature; required for changes that may affect users
15+
- [ ] Updated [input and output guide](/MODFLOW-ORG/modflow6/doc/mf6io)
1616
- [ ] Removed checklist items not relevant to this pull request
1717

18-
For additional information see [instructions for contributing](/MODFLOW-USGS/modflow6/.github/CONTRIBUTING.md) and [instructions for developing](/MODFLOW-USGS/modflow6/.github/DEVELOPER.md).
18+
For additional information see [instructions for contributing](/MODFLOW-ORG/modflow6/.github/CONTRIBUTING.md) and [instructions for developing](/MODFLOW-ORG/modflow6/.github/DEVELOPER.md).

.github/workflows/ci.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -231,13 +231,13 @@ jobs:
231231
- name: Checkout test models
232232
uses: actions/checkout@v4
233233
with:
234-
repository: MODFLOW-USGS/modflow6-testmodels
234+
repository: MODFLOW-ORG/modflow6-testmodels
235235
path: modflow6-testmodels
236236

237237
- name: Checkout examples
238238
uses: actions/checkout@v4
239239
with:
240-
repository: MODFLOW-USGS/modflow6-examples
240+
repository: MODFLOW-ORG/modflow6-examples
241241
path: modflow6-examples
242242

243243
- name: Setup ${{ env.FC }} ${{ env.FC_V }}
@@ -335,7 +335,7 @@ jobs:
335335
if: runner.os == 'Linux'
336336
uses: actions/checkout@v4
337337
with:
338-
repository: MODFLOW-USGS/usgslatex
338+
repository: MODFLOW-ORG/usgslatex
339339
path: usgslatex
340340

341341
- name: Install TeX Live
@@ -397,13 +397,13 @@ jobs:
397397
- name: Checkout test models
398398
uses: actions/checkout@v4
399399
with:
400-
repository: MODFLOW-USGS/modflow6-testmodels
400+
repository: MODFLOW-ORG/modflow6-testmodels
401401
path: modflow6-testmodels
402402

403403
- name: Checkout examples
404404
uses: actions/checkout@v4
405405
with:
406-
repository: MODFLOW-USGS/modflow6-examples
406+
repository: MODFLOW-ORG/modflow6-examples
407407
path: modflow6-examples
408408

409409
- name: Setup pixi

.github/workflows/compilers.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,13 @@ jobs:
7878
- name: Checkout modflow6-testmodels
7979
uses: actions/checkout@v4
8080
with:
81-
repository: MODFLOW-USGS/modflow6-testmodels
81+
repository: MODFLOW-ORG/modflow6-testmodels
8282
path: modflow6-testmodels
8383

8484
- name: Checkout modflow6-examples
8585
uses: actions/checkout@v4
8686
with:
87-
repository: MODFLOW-USGS/modflow6-examples
87+
repository: MODFLOW-ORG/modflow6-examples
8888
path: modflow6-examples
8989

9090
- name: Setup ${{ matrix.compiler }} ${{ matrix.version }}

.github/workflows/docs.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ jobs:
5353
- name: Checkout modflow6-examples
5454
uses: actions/checkout@v4
5555
with:
56-
repository: MODFLOW-USGS/modflow6-examples
56+
repository: MODFLOW-ORG/modflow6-examples
5757
path: modflow6-examples
5858

5959
- name: Checkout usgslatex
6060
uses: actions/checkout@v4
6161
with:
62-
repository: MODFLOW-USGS/usgslatex
62+
repository: MODFLOW-ORG/usgslatex
6363
path: usgslatex
6464

6565
- name: Setup pixi
@@ -201,7 +201,7 @@ jobs:
201201
name: rtd-trigger
202202
needs: rtd_build
203203
runs-on: ubuntu-22.04
204-
if: github.repository_owner == 'MODFLOW-USGS' && github.event_name == 'push'
204+
if: github.repository_owner == 'MODFLOW-ORG' && github.event_name == 'push'
205205
steps:
206206
- name: Checkout repo
207207
uses: actions/checkout@v4

.github/workflows/large.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ jobs:
6363
- name: Checkout modflow6-largetestmodels
6464
uses: actions/checkout@v4
6565
with:
66-
repository: MODFLOW-USGS/modflow6-largetestmodels
66+
repository: MODFLOW-ORG/modflow6-largetestmodels
6767
path: modflow6-largetestmodels
6868

6969
- name: Setup pixi

.github/workflows/release.yml

+9-9
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ on:
1414
required: true
1515
type: string
1616
compiler_toolchain:
17-
description: 'Compiler toolchain to use. For supported options see https://github.com/MODFLOW-USGS/modflow6/blob/develop/DEVELOPER.md#compiler-compatibility.'
17+
description: 'Compiler toolchain to use. For supported options see https://github.com/MODFLOW-ORG/modflow6/blob/develop/DEVELOPER.md#compiler-compatibility.'
1818
required: false
1919
type: string
2020
default: 'intel-classic'
2121
compiler_version:
22-
description: 'Compiler version to use. For supported options see https://github.com/MODFLOW-USGS/modflow6/blob/develop/DEVELOPER.md#compiler-compatibility.'
22+
description: 'Compiler version to use. For supported options see https://github.com/MODFLOW-ORG/modflow6/blob/develop/DEVELOPER.md#compiler-compatibility.'
2323
required: false
2424
type: string
2525
default: '2021.7'
@@ -269,14 +269,14 @@ jobs:
269269
if: inputs.run_tests == true && runner.os != 'Windows'
270270
uses: actions/checkout@v4
271271
with:
272-
repository: MODFLOW-USGS/modflow6-testmodels
272+
repository: MODFLOW-ORG/modflow6-testmodels
273273
path: modflow6-testmodels
274274

275275
- name: Checkout modflow6-examples
276276
if: inputs.run_tests == true && runner.os != 'Windows'
277277
uses: actions/checkout@v4
278278
with:
279-
repository: MODFLOW-USGS/modflow6-examples
279+
repository: MODFLOW-ORG/modflow6-examples
280280
path: modflow6-examples
281281

282282
- name: Update flopy
@@ -323,7 +323,7 @@ jobs:
323323
if: ${{ runner.os == 'Linux' && inputs.run_tests == true }}
324324
uses: actions/checkout@v4
325325
with:
326-
repository: MODFLOW-USGS/usgslatex
326+
repository: MODFLOW-ORG/usgslatex
327327
path: usgslatex
328328

329329
- name: Install TeX Live
@@ -367,13 +367,13 @@ jobs:
367367
- name: Checkout modflow6-examples
368368
uses: actions/checkout@v4
369369
with:
370-
repository: MODFLOW-USGS/modflow6-examples
370+
repository: MODFLOW-ORG/modflow6-examples
371371
path: modflow6-examples
372372

373373
- name: Checkout usgslatex
374374
uses: actions/checkout@v4
375375
with:
376-
repository: MODFLOW-USGS/usgslatex
376+
repository: MODFLOW-ORG/usgslatex
377377
path: usgslatex
378378

379379
- name: Install TeX Live
@@ -476,7 +476,7 @@ jobs:
476476
- name: Build documentation
477477
env:
478478
# this step is lazy about building the mf6 examples PDF document, first
479-
# trying to download a prebuilt PDF from MODFLOW-USGS/modflow6-examples,
479+
# trying to download a prebuilt PDF from MODFLOW-ORG/modflow6-examples,
480480
# so it needs a GITHUB_TOKEN.
481481
GITHUB_TOKEN: ${{ github.token }}
482482
run: |
@@ -529,7 +529,7 @@ jobs:
529529
- name: Checkout modflow6-examples
530530
uses: actions/checkout@v4
531531
with:
532-
repository: MODFLOW-USGS/modflow6-examples
532+
repository: MODFLOW-ORG/modflow6-examples
533533
path: modflow6-examples
534534

535535
- name: Setup Micromamba

.github/workflows/release_dispatch.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ on:
2525
required: true
2626
type: string
2727
compiler_toolchain:
28-
description: 'Compiler toolchain to use. For supported options see https://github.com/MODFLOW-USGS/modflow6/blob/develop/DEVELOPER.md#compiler-compatibility.'
28+
description: 'Compiler toolchain to use. For supported options see https://github.com/MODFLOW-ORG/modflow6/blob/develop/DEVELOPER.md#compiler-compatibility.'
2929
required: false
3030
type: string
3131
default: 'intel-classic'
3232
compiler_version:
33-
description: 'Compiler version to use. For supported options see https://github.com/MODFLOW-USGS/modflow6/blob/develop/DEVELOPER.md#compiler-compatibility.'
33+
description: 'Compiler version to use. For supported options see https://github.com/MODFLOW-ORG/modflow6/blob/develop/DEVELOPER.md#compiler-compatibility.'
3434
required: false
3535
type: string
3636
default: '2021.7'
@@ -146,7 +146,7 @@ jobs:
146146
echo "models=$models" >> $GITHUB_OUTPUT
147147
make_dist:
148148
name: Make distribution
149-
uses: MODFLOW-USGS/modflow6/.github/workflows/release.yml@develop
149+
uses: MODFLOW-ORG/modflow6/.github/workflows/release.yml@develop
150150
needs: set_options
151151
with:
152152
# If the workflow is manually triggered, the maintainer must manually set approve=true to approve a release.

CITATION.cff

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ abstract: MODFLOW 6 is an object-oriented program and framework developed to pro
1010
same simulation. Within this framework, a regional-scale groundwater model may be
1111
coupled with multiple local-scale groundwater models. Or, a groundwater flow model
1212
could be coupled to a groundwater transport model of a single solute species.
13-
repository-code: https://github.com/MODFLOW-USGS/modflow6
13+
repository-code: https://github.com/MODFLOW-ORG/modflow6
1414
license: CC0-1.0
1515
authors:
1616
- family-names: Langevin

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ We want to fix all issues as soon as possible, but we first need to reproduce an
4545

4646
Please provide such an example. This saves maintainers time and ultimately allows us to fix more bugs. While we understand it might be difficult to isolate the essence of a problem, bugs can only be investigated or fixed if problems are accurately identified. Issues lacking sufficient information to reproduce may be closed.
4747

48-
File an issue by filling out our [issue form](https://github.com/MODFLOW-USGS/modflow6/issues/new).
48+
File an issue by filling out our [issue form](https://github.com/MODFLOW-ORG/modflow6/issues/new).
4949

5050
### Questions
5151

52-
Please do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. Questions can be asked on the [discussions page](https://github.com/MODFLOW-USGS/modflow6/discussions) under the Q&A category or on [Stack Overflow](https://stackoverflow.com/questions/tagged/modflow6) with tag `modflow6`.
52+
Please do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. Questions can be asked on the [discussions page](https://github.com/MODFLOW-ORG/modflow6/discussions) under the Q&A category or on [Stack Overflow](https://stackoverflow.com/questions/tagged/modflow6) with tag `modflow6`.
5353

5454
We will systematically close all issues that are requests for general support.
5555

@@ -64,8 +64,8 @@ If you would like to implement a new feature:
6464

6565
To submit a pull request (PR):
6666

67-
1. To avoid duplicating effort, [search](https://github.com/MODFLOW-USGS/modflow6/pulls) for an open or closed PR that relates to your submission.
68-
2. Fork the MODFLOW-USGS/modflow6 repo and make your changes in a new branch, following our style and commit message guidelines and [including appropriate test cases](./DEVELOPER.md#writing-tests).
67+
1. To avoid duplicating effort, [search](https://github.com/MODFLOW-ORG/modflow6/pulls) for an open or closed PR that relates to your submission.
68+
2. Fork the MODFLOW-ORG/modflow6 repo and make your changes in a new branch, following our style and commit message guidelines and [including appropriate test cases](./DEVELOPER.md#writing-tests).
6969
3. [Check the spelling and formatting](./DEVELOPER.md#formatting) of any modified or new Fortran source files, python files definition files, markdown, and LaTeX files.
7070
4. [Rebuild makefiles](./DEVELOPER.md#generating-makefiles) and update MSVS project files if you added, removed, or renamed any source files.
7171
5. [Run the full test suite](./DEVELOPER.md#running-tests) and make sure all tests pass.
@@ -100,7 +100,7 @@ Adherence to commit message formatting rules results in consistent messages and
100100

101101
Each commit message consists of three components: **header** (required), **body** (optional) and **footer** (optional). The header has three subcomponents: **type** (required), **scope** (optional) and **subject** (required):
102102

103-
See [the develop branch history](https://github.com/MODFLOW-USGS/modflow6/commits/develop) to get a sense for the commit style.
103+
See [the develop branch history](https://github.com/MODFLOW-ORG/modflow6/commits/develop) to get a sense for the commit style.
104104

105105
### Template
106106

DEVELOPER.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ Visual Studio installers can be downloaded from the [official website](https://v
202202

203203
*Doxygen & LaTeX*
204204

205-
[Doxygen](https://www.doxygen.nl/index.html) is used to generate the [MODFLOW 6 source code documentation](https://modflow-usgs.github.io/modflow6/). [Graphviz](https://graphviz.org/) is used by doxygen to produce source code diagrams. [LaTeX](https://www.latex-project.org/) is used to generate the MODFLOW 6 release notes and Input/Output documents.
205+
[Doxygen](https://www.doxygen.nl/index.html) is used to generate the [MODFLOW 6 source code documentation](https://MODFLOW-ORG.github.io/modflow6/). [Graphviz](https://graphviz.org/) is used by doxygen to produce source code diagrams. [LaTeX](https://www.latex-project.org/) is used to generate the MODFLOW 6 release notes and Input/Output documents.
206206

207207
These programs can be installed from various sources, including by conda, macports, or from individual sources such as https://www.tug.org/. Details about USGS LaTeX libraries can be seen in addition to linux installs in the CI workflow for the docs (`.github/workflows/ci-docs.yml`).
208208

@@ -212,7 +212,7 @@ These programs can be installed from various sources, including by conda, macpor
212212
Fork and clone the MODFLOW 6 repository:
213213

214214
1. Login to your GitHub account or create one by following the instructions given [here](https://github.com/signup/free).
215-
2. [Fork](http://help.github.com/forking) the [main MODFLOW 6](https://github.com/MODFLOW-USGS/modflow6).
215+
2. [Fork](http://help.github.com/forking) the [main MODFLOW 6](https://github.com/MODFLOW-ORG/modflow6).
216216
3. Clone your fork of the MODFLOW 6 repository and create an `upstream` remote pointing back to your fork.
217217

218218
After forking the MODFLOW 6 repository on GitHub.
@@ -232,7 +232,7 @@ cd modflow6
232232
3. Add the main MODFLOW 6 repository as an upstream remote to your repository.
233233

234234
```shell
235-
git remote add upstream https://github.com/MODFLOW-USGS/modflow6.git
235+
git remote add upstream https://github.com/MODFLOW-ORG/modflow6.git
236236
```
237237

238238
## Install the python environment
@@ -302,7 +302,7 @@ Like MODFLOW 6, `flopy` is modular &mdash; for each MODFLOW 6 package there is g
302302

303303
#### `modflow-devtools`
304304

305-
The tests use a set of shared fixtures and utilities provided by the [`modflow-devtools`](https://github.com/MODFLOW-USGS/modflow-devtools) package.
305+
The tests use a set of shared fixtures and utilities provided by the [`modflow-devtools`](https://github.com/MODFLOW-ORG/modflow-devtools) package.
306306

307307
## Building
308308

@@ -517,11 +517,11 @@ As mentioned above, binaries live in the `bin` subdirectory of the project root.
517517

518518
- local development binaries in the top-level `bin`
519519
- binaries rebuilt in development mode from the latest MODFLOW 6 release in `bin/rebuilt/`
520-
- related programs installed from the [executables distribution](https://github.com/MODFLOW-USGS/executables/releases) in `bin/downloaded/`
520+
- related programs installed from the [executables distribution](https://github.com/MODFLOW-ORG/executables/releases) in `bin/downloaded/`
521521

522522
##### Rebuilding release binaries
523523

524-
Tests require the latest official MODFLOW 6 release to be compiled in develop mode with the same Fortran compiler as the development version. A number of binaries distributed from the [executables repo](https://github.com/MODFLOW-USGS/executables) must also be installed. The script `autotest/get_exes.py` does both of these things. It can be run from the project root with:
524+
Tests require the latest official MODFLOW 6 release to be compiled in develop mode with the same Fortran compiler as the development version. A number of binaries distributed from the [executables repo](https://github.com/MODFLOW-ORG/executables) must also be installed. The script `autotest/get_exes.py` does both of these things. It can be run from the project root with:
525525

526526
```shell
527527
pixi run get-exes
@@ -575,9 +575,9 @@ pixi run update-fortran-definitions
575575

576576
Some autotests load models from external repositories:
577577

578-
- [`MODFLOW-USGS/modflow6-testmodels`](https://github.com/MODFLOW-USGS/modflow6-testmodels)
579-
- [`MODFLOW-USGS/modflow6-largetestmodels`](https://github.com/MODFLOW-USGS/modflow6-largetestmodels)
580-
- [`MODFLOW-USGS/modflow6-examples`](https://github.com/MODFLOW-USGS/modflow6-examples)
578+
- [`MODFLOW-ORG/modflow6-testmodels`](https://github.com/MODFLOW-ORG/modflow6-testmodels)
579+
- [`MODFLOW-ORG/modflow6-largetestmodels`](https://github.com/MODFLOW-ORG/modflow6-largetestmodels)
580+
- [`MODFLOW-ORG/modflow6-examples`](https://github.com/MODFLOW-ORG/modflow6-examples)
581581

582582
See the [MODFLOW devtools documentation](https://modflow-devtools.readthedocs.io/en/latest/md/install.html#installing-external-model-repositories) for instructions to install external model repositories.
583583

@@ -789,7 +789,7 @@ The framework has three hooks:
789789

790790
A test script conventionally contains one or more test cases, fed to the test function as `idx, name` pairs. `idx` can be used to index parameter values or expected results for a specific test case. The test case `name` is useful for model/subdirectory naming, etc.
791791

792-
The framework will not run an unknown program. The path to any program under test (or used for a comparison) must be registered in the `targets` dictionary. Keys are strings. See `autotest/conftest.py` for the contents of `targets` &mdash; naming follows the [executables distribution](https://github.com/MODFLOW-USGS/executables).
792+
The framework will not run an unknown program. The path to any program under test (or used for a comparison) must be registered in the `targets` dictionary. Keys are strings. See `autotest/conftest.py` for the contents of `targets` &mdash; naming follows the [executables distribution](https://github.com/MODFLOW-ORG/executables).
793793

794794
The `.run()` function
795795

0 commit comments

Comments
 (0)