Skip to content

Commit

Permalink
chore: rename (MODFLOW-ORG#189)
Browse files Browse the repository at this point in the history
  • Loading branch information
wpbonelli authored Mar 3, 2025
1 parent f8d34f3 commit 835de1c
Show file tree
Hide file tree
Showing 11 changed files with 98 additions and 98 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,25 +90,25 @@ jobs:
- name: Checkout modflow6
uses: actions/checkout@v4
with:
repository: MODFLOW-USGS/modflow6
repository: MODFLOW-ORG/modflow6
path: modflow6

- name: Checkout modflow6 examples
uses: actions/checkout@v4
with:
repository: MODFLOW-USGS/modflow6-examples
repository: MODFLOW-ORG/modflow6-examples
path: modflow6-examples

- name: Checkout modflow6 test models
uses: actions/checkout@v3
with:
repository: MODFLOW-USGS/modflow6-testmodels
repository: MODFLOW-ORG/modflow6-testmodels
path: modflow6-testmodels

- name: Checkout modflow6 large test models
uses: actions/checkout@v3
with:
repository: MODFLOW-USGS/modflow6-largetestmodels
repository: MODFLOW-ORG/modflow6-largetestmodels
path: modflow6-largetestmodels

- name: Install executables
Expand Down Expand Up @@ -178,7 +178,7 @@ jobs:
name: Docs
needs: test
runs-on: ubuntu-22.04
if: github.repository_owner == 'MODFLOW-USGS' && github.event_name == 'push'
if: github.repository_owner == 'MODFLOW-ORG' && github.event_name == 'push'
steps:
- name: Trigger RTD
uses: dfm/rtds-action@v1
Expand Down
2 changes: 1 addition & 1 deletion DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The `modflow-devtools` release procedure is automated with GitHub Actions in [`.
2. Reinitialize the `develop` branch
3. Publish the package to PyPI

To begin an automated release, create a release branch from `develop`. The release branch name should be the version number of with a `v`a prefix (e.g., `v0.0.6`). Pushing the release branch to the `MODFLOW-USGS/modflow-devtools` repository will trigger the release workflow, which begins with the following steps:
To begin an automated release, create a release branch from `develop`. The release branch name should be the version number of with a `v`a prefix (e.g., `v0.0.6`). Pushing the release branch to the `MODFLOW-ORG/modflow-devtools` repository will trigger the release workflow, which begins with the following steps:

- update version strings to match the version number in the release branch name
- generate a changelog since the last release and update `HISTORY.md`
Expand Down
116 changes: 58 additions & 58 deletions HISTORY.md

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# MODFLOW developer tools

[![CI](https://github.com/MODFLOW-USGS/modflow-devtools/actions/workflows/ci.yml/badge.svg)](https://github.com/MODFLOW-USGS/modflow-devtools/actions/workflows/ci.yml)
[![CI](https://github.com/MODFLOW-ORG/modflow-devtools/actions/workflows/ci.yml/badge.svg)](https://github.com/MODFLOW-ORG/modflow-devtools/actions/workflows/ci.yml)
[![Documentation Status](https://readthedocs.org/projects/modflow-devtools/badge/?version=latest)](https://modflow-devtools.readthedocs.io/en/latest/?badge=latest)
[![GitHub contributors](https://img.shields.io/github/contributors/MODFLOW-USGS/modflow-devtools)](https://img.shields.io/github/contributors/MODFLOW-USGS/modflow-devtools)
[![GitHub tag](https://img.shields.io/github/tag/MODFLOW-USGS/modflow-devtools.svg)](https://github.com/MODFLOW-USGS/modflow-devtools/tags/latest)
[![GitHub contributors](https://img.shields.io/github/contributors/MODFLOW-ORG/modflow-devtools)](https://img.shields.io/github/contributors/MODFLOW-ORG/modflow-devtools)
[![GitHub tag](https://img.shields.io/github/tag/MODFLOW-ORG/modflow-devtools.svg)](https://github.com/MODFLOW-ORG/modflow-devtools/tags/latest)

[![PyPI License](https://img.shields.io/pypi/l/modflow-devtools)](https://pypi.python.org/pypi/modflow-devtools)
[![PyPI Status](https://img.shields.io/pypi/status/modflow-devtools.png)](https://pypi.python.org/pypi/modflow-devtools)
Expand Down Expand Up @@ -46,9 +46,9 @@ Pytest features include:
- Python packages installed
- executables available on the PATH
- test fixtures for example / test models in
- `MODFLOW-USGS/modflow6-examples`
- `MODFLOW-USGS/modflow6-testmodels`
- `MODFLOW-USGS/modflow6-largetestmodels`
- `MODFLOW-ORG/modflow6-examples`
- `MODFLOW-ORG/modflow6-testmodels`
- `MODFLOW-ORG/modflow6-largetestmodels`

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion autotest/test_dfn.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
DFN_DIR = PROJ_ROOT / "autotest" / "temp" / "dfn"
TOML_DIR = DFN_DIR / "toml"
VERSIONS = {1: DFN_DIR, 2: TOML_DIR}
MF6_OWNER = "MODFLOW-USGS"
MF6_OWNER = "MODFLOW-ORG"
MF6_REPO = "modflow6"
MF6_REF = "develop"

Expand Down
12 changes: 6 additions & 6 deletions autotest/test_download.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
from modflow_devtools.markers import requires_github

_repos = [
"MODFLOW-USGS/modflow6",
"MODFLOW-USGS/modflow6-nightly-build",
"MODFLOW-USGS/executables",
"MODFLOW-ORG/modflow6",
"MODFLOW-ORG/modflow6-nightly-build",
"MODFLOW-ORG/executables",
]


Expand All @@ -34,7 +34,7 @@ def test_get_releases(repo):
assert all(repo in a["browser_download_url"] for a in assets)

# test page size option
if repo == "MODFLOW-USGS/modflow6-nightly-build":
if repo == "MODFLOW-ORG/modflow6-nightly-build":
assert len(releases) <= 31 # 30-day retention period


Expand All @@ -48,7 +48,7 @@ def test_get_release(repo):
expected_names = ["linux.zip", "mac.zip", "win64.zip"]
actual_names = [asset["name"] for asset in assets]

if repo == "MODFLOW-USGS/modflow6":
if repo == "MODFLOW-ORG/modflow6":
# can remove if modflow6 releases follow asset name
# conventions followed in executables and nightly build repos
assert {a.rpartition("_")[2] for a in actual_names} >= {
Expand All @@ -64,7 +64,7 @@ def test_get_release(repo):
def test_download_and_unzip(function_tmpdir, delete_zip):
zip_name = "mf6.3.0_linux.zip"
dir_name = zip_name.replace(".zip", "")
url = f"https://github.com/MODFLOW-USGS/modflow6/releases/download/6.3.0/{zip_name}"
url = f"https://github.com/MODFLOW-ORG/modflow6/releases/download/6.3.0/{zip_name}"
download_and_unzip(url, function_tmpdir, delete_zip=delete_zip, verbose=True)

assert (function_tmpdir / zip_name).is_file() != delete_zip
Expand Down
2 changes: 1 addition & 1 deletion cliff.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ body = """
{% for group, commits in commits | group_by(attribute="group") %}
#### {{ group | upper_first }}
{% for commit in commits %}
* [{{ commit.group }}{% if commit.scope %}({{ commit.scope }}){% endif %}](https://github.com/MODFLOW-USGS/modflow-devtools/commit/{{ commit.id }}): {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}. Committed by {{ commit.author.name }} on {{ commit.author.timestamp | date(format="%Y-%m-%d") }}.\
* [{{ commit.group }}{% if commit.scope %}({{ commit.scope }}){% endif %}](https://github.com/MODFLOW-ORG/modflow-devtools/commit/{{ commit.id }}): {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}. Committed by {{ commit.author.name }} on {{ commit.author.timestamp | date(format="%Y-%m-%d") }}.\
{% endfor %}
{% endfor %}\n
"""
Expand Down
4 changes: 2 additions & 2 deletions docs/md/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For instance, to retrieve information about the latest executables release, then
```python
from modflow_devtools.download import get_release

release = get_release("MODFLOW-USGS/executables")
release = get_release("MODFLOW-ORG/executables")
assets = release["assets"]
print([asset["name"] for asset in assets])
```
Expand All @@ -29,7 +29,7 @@ For instance, to download a MODFLOW 6.4.1 Linux distribution and delete the zipf
```python
from modflow_devtools.download import download_and_unzip

url = f"https://github.com/MODFLOW-USGS/modflow6/releases/download/6.4.1/mf6.4.1_linux.zip"
url = f"https://github.com/MODFLOW-ORG/modflow6/releases/download/6.4.1/mf6.4.1_linux.zip"
download_and_unzip(url, "~/Downloads", delete_zip=True, verbose=True)
```

Expand Down
18 changes: 9 additions & 9 deletions docs/md/fixtures.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ There is also a `--keep-failed <path>` option which preserves outputs only from

Fixtures are provided to find models from the MODFLOW 6 example and test model repositories and feed them to test functions. Models can be loaded from:

- [`MODFLOW-USGS/modflow6-examples`](https://github.com/MODFLOW-USGS/modflow6-examples)
- [`MODFLOW-USGS/modflow6-testmodels`](https://github.com/MODFLOW-USGS/modflow6-testmodels)
- [`MODFLOW-USGS/modflow6-largetestmodels`](https://github.com/MODFLOW-USGS/modflow6-largetestmodels)
- [`MODFLOW-ORG/modflow6-examples`](https://github.com/MODFLOW-ORG/modflow6-examples)
- [`MODFLOW-ORG/modflow6-testmodels`](https://github.com/MODFLOW-ORG/modflow6-testmodels)
- [`MODFLOW-ORG/modflow6-largetestmodels`](https://github.com/MODFLOW-ORG/modflow6-largetestmodels)

These models can be requested like any other `pytest` fixture, by adding one of the following parameters to test functions:

Expand All @@ -68,7 +68,7 @@ It is recommended to set the environment variable `REPOS_PATH` to the location o

#### MODFLOW 2005 test models

The `test_model_mf5to6` fixture are each a `Path` to the model's namefile. For example, to load `mf5to6` models from the `MODFLOW-USGS/modflow6-testmodels` repo:
The `test_model_mf5to6` fixture are each a `Path` to the model's namefile. For example, to load `mf5to6` models from the `MODFLOW-ORG/modflow6-testmodels` repo:

```python
def test_mf5to6_model(test_model_mf5to6):
Expand All @@ -77,11 +77,11 @@ def test_mf5to6_model(test_model_mf5to6):
assert test_model_mf5to6.suffix == ".nam"
```

This test function will be parametrized with all models found in the `mf5to6` subdirectory of the [`MODFLOW-USGS/modflow6-testmodels`](https://github.com/MODFLOW-USGS/modflow6-testmodels) repository. Note that MODFLOW-2005 namefiles need not be named `mfsim.nam`.
This test function will be parametrized with all models found in the `mf5to6` subdirectory of the [`MODFLOW-ORG/modflow6-testmodels`](https://github.com/MODFLOW-ORG/modflow6-testmodels) repository. Note that MODFLOW-2005 namefiles need not be named `mfsim.nam`.

#### MODFLOW 6 test models

The `test_model_mf6` fixture loads all MODFLOW 6 models found in the `mf6` subdirectory of the `MODFLOW-USGS/modflow6-testmodels` repository.
The `test_model_mf6` fixture loads all MODFLOW 6 models found in the `mf6` subdirectory of the `MODFLOW-ORG/modflow6-testmodels` repository.

```python
def test_test_model_mf6(test_model_mf6):
Expand All @@ -94,7 +94,7 @@ Because these are MODFLOW 6 models, each namefile will be named `mfsim.nam`. The

#### Large test models

The `large_test_model` fixture loads all MODFLOW 6 models found in the `MODFLOW-USGS/modflow6-largetestmodels` repository.
The `large_test_model` fixture loads all MODFLOW 6 models found in the `MODFLOW-ORG/modflow6-largetestmodels` repository.

```python
def test_large_test_model(large_test_model):
Expand All @@ -106,7 +106,7 @@ def test_large_test_model(large_test_model):

#### Example scenarios

The [`MODFLOW-USGS/modflow6-examples`](https://github.com/MODFLOW-USGS/modflow6-examples) repository contains a collection of example scenarios, each with 1 or more models. The `example_scenario` fixture is a `Tuple[str, List[Path]]`. The first item is the name of the scenario. The second item is a list of MODFLOW 6 namefile `Path`s, ordered alphabetically by name, with models generally named as follows:
The [`MODFLOW-ORG/modflow6-examples`](https://github.com/MODFLOW-ORG/modflow6-examples) repository contains a collection of example scenarios, each with 1 or more models. The `example_scenario` fixture is a `Tuple[str, List[Path]]`. The first item is the name of the scenario. The second item is a list of MODFLOW 6 namefile `Path`s, ordered alphabetically by name, with models generally named as follows:

- groundwater flow models begin with `gwf*`
- transport models begin with `gwt*`
Expand All @@ -133,7 +133,7 @@ External model test cases can be filtered by model name or by the packages the m

Filtering models by name is functionally equivalent to filtering `pytest` cases with `-k`. (In the former case the filter is applied before test collection, while the latter collects tests as usual and then applies the filter.)

For instance, running the `test_largetestmodels.py` script in the `MODFLOW-USGS/modflow6` repository's `autotest/` folder, and selecting a particular model from the `MODFLOW-USGS/largetestmodels` repository by name:
For instance, running the `test_largetestmodels.py` script in the `MODFLOW-ORG/modflow6` repository's `autotest/` folder, and selecting a particular model from the `MODFLOW-ORG/largetestmodels` repository by name:

```shell
autotest % pytest -v test_largetestmodels.py --collect-only --model test1002_biscqtg_disv_gnc_nr_dev
Expand Down
14 changes: 7 additions & 7 deletions docs/md/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pip install modflow-devtools
To set up a `modflow-devtools` development environment, first clone the repository:

```shell
git clone https://github.com/MODFLOW-USGS/modflow-devtools.git
git clone https://github.com/MODFLOW-ORG/modflow-devtools.git
```

Then install the local copy as well as testing, linting, and docs dependencies:
Expand All @@ -35,9 +35,9 @@ pytest_plugins = ["modflow_devtools.fixtures"]

`modflow-devtools` provides fixtures to load models from external repositories:

- [`MODFLOW-USGS/modflow6-examples`](https://github.com/MODFLOW-USGS/modflow6-examples)
- [`MODFLOW-USGS/modflow6-testmodels`](https://github.com/MODFLOW-USGS/modflow6-testmodels)
- [`MODFLOW-USGS/modflow6-largetestmodels`](https://github.com/MODFLOW-USGS/modflow6-largetestmodels)
- [`MODFLOW-ORG/modflow6-examples`](https://github.com/MODFLOW-ORG/modflow6-examples)
- [`MODFLOW-ORG/modflow6-testmodels`](https://github.com/MODFLOW-ORG/modflow6-testmodels)
- [`MODFLOW-ORG/modflow6-largetestmodels`](https://github.com/MODFLOW-ORG/modflow6-largetestmodels)

By default, these fixtures expect model repositories to live next to (i.e. in the same parent directory as) the consuming project repository. If the repos are somewhere else, you can set the `REPOS_PATH` environment variable to point to their parent directory.

Expand All @@ -48,16 +48,16 @@ By default, these fixtures expect model repositories to live next to (i.e. in th
The test model repos can simply be cloned &mdash; ideally, into the parent directory of the `modflow6` repository, so that repositories live side-by-side:

```shell
git clone https://github.com/MODFLOW-USGS/modflow6-testmodels.git
git clone https://github.com/MODFLOW-USGS/modflow6-largetestmodels.git
git clone https://github.com/MODFLOW-ORG/modflow6-testmodels.git
git clone https://github.com/MODFLOW-ORG/modflow6-largetestmodels.git
```

### Installing example models

First clone the example models repo:

```shell
git clone https://github.com/MODFLOW-USGS/modflow6-examples.git
git clone https://github.com/MODFLOW-ORG/modflow6-examples.git
```

The example models require some setup after cloning. Some extra Python dependencies are required to build the examples:
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@ dev = [

[project.urls]
"Documentation" = "https://modflow-devtools.readthedocs.io/en/latest/"
"Bug Tracker" = "https://github.com/MODFLOW-USGS/modflow-devtools/issues"
"Source Code" = "https://github.com/MODFLOW-USGS/modflow-devtools"
"Bug Tracker" = "https://github.com/MODFLOW-ORG/modflow-devtools/issues"
"Source Code" = "https://github.com/MODFLOW-ORG/modflow-devtools"

[tool.hatch.build.targets.sdist]
only-include = ["modflow_devtools"]
Expand Down

0 comments on commit 835de1c

Please sign in to comment.