From 8edfd70c1c11ce4438426c3c446c67fdcdf819c4 Mon Sep 17 00:00:00 2001 From: ssolson Date: Thu, 5 Dec 2024 11:51:43 -0500 Subject: [PATCH 1/3] `master` => `main` default branch --- .github/workflows/main.yml | 6 +++--- .github/workflows/pypi.yml | 4 ++-- README.md | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 53f291c67..f87fc89fa 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -3,11 +3,11 @@ name: Py 3.10, 3.11, 3.12 | Windows Mac Linux on: push: branches: - - master + - main - develop pull_request: branches: - - master + - main - develop jobs: @@ -44,7 +44,7 @@ jobs: - id: hindcast-logic run: | - if [[ "${{ github.event.pull_request.base.ref }}" == "master" || "${{ steps.changes.outputs.wave_io_hindcast }}" == "true" ]]; then + if [[ "${{ github.event.pull_request.base.ref }}" == "main" || "${{ steps.changes.outputs.wave_io_hindcast }}" == "true" ]]; then echo "should-run-hindcast=true" >> "$GITHUB_OUTPUT" else echo "should-run-hindcast=false" >> "$GITHUB_OUTPUT" diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml index 239b3fa1d..ed41bb00d 100644 --- a/.github/workflows/pypi.yml +++ b/.github/workflows/pypi.yml @@ -1,4 +1,4 @@ -# Builds mhkit and publishes to testpypi.org on every commit to master. On tagged commits, also publishes to pypi.org. +# Builds mhkit and publishes to testpypi.org on every commit to main. On tagged commits, also publishes to pypi.org. # https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/ name: Build and release 🐍 📦 @@ -6,7 +6,7 @@ name: Build and release 🐍 📦 on: push: branches: - - master + - main release: types: [published] diff --git a/README.md b/README.md index 4a6f5c3d6..2c00db8e2 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ - - + + @@ -82,7 +82,7 @@ The GitHub platform has the branch feature that facilitates code contributions a 1. Navigate to your fork of MHKiT-Python (see instructions above) 2. Above the list of files, click **Branches**. 3. Click **New Branch**. -4. Enter a name for the branch. Be sure to select **MHKiT-Software/MHKiT-Python:master** as the source. +4. Enter a name for the branch. Be sure to select **MHKiT-Software/MHKiT-Python:main** as the source. 5. Click **Create branch**. You will now have a branch on your fork of MHKiT-Python that you can use to work with the code base. ## Creating a pull request From 3edee8812a6a8b8905b479618ec61a2d2f655db1 Mon Sep 17 00:00:00 2001 From: ssolson Date: Mon, 9 Dec 2024 11:32:20 -0500 Subject: [PATCH 2/3] MHKiT installation codebox & order --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2c00db8e2..f38a8c3a3 100644 --- a/README.md +++ b/README.md @@ -33,14 +33,16 @@ See the [MHKiT documentation](https://mhkit-software.github.io/MHKiT) for more i ## Installation MHKiT-Python requires Python (3.10, 3.11, 3.12) along with several Python -package dependencies. MHKiT-Python can be installed from PyPI using the command: +package dependencies. MHKiT-Python can be installed using the Conda package manager: -`pip install mhkit` +```bash +conda install -c conda-forge mhkit +``` -MHKiT can alternatively be installed using conda: +MHKiT can alternatively be installed from PyPi using pip: ```bash -conda install -c conda-forge mhkit +pip install mhkit ``` See [installation instructions](https://mhkit-software.github.io/MHKiT/installation.html) for more information. From d91b56e71492b3e6c411117cdbee3a20322cee41 Mon Sep 17 00:00:00 2001 From: ssolson Date: Mon, 9 Dec 2024 12:13:08 -0500 Subject: [PATCH 3/3] master -> main --- examples/qc_example.ipynb | 4 ++-- examples/river_example.ipynb | 4 ++-- examples/tidal_example.ipynb | 9 ++------- 3 files changed, 6 insertions(+), 11 deletions(-) diff --git a/examples/qc_example.ipynb b/examples/qc_example.ipynb index c5a853f39..914eb9035 100644 --- a/examples/qc_example.ipynb +++ b/examples/qc_example.ipynb @@ -5,7 +5,7 @@ "metadata": {}, "source": [ "# MHKiT Quality Control Module\n", - "The following example runs a simple quality control analysis on wave elevation data using the [MHKiT QC module](https://mhkit-software.github.io/MHKiT/mhkit-python/api.qc.html). The data file used in this example is stored in the [\\\\\\\\MHKiT\\\\\\\\examples\\\\\\\\data](https://github.com/MHKiT-Software/MHKiT-Python/tree/master/examples/data) directory.\n", + "The following example runs a simple quality control analysis on wave elevation data using the [MHKiT QC module](https://mhkit-software.github.io/MHKiT/mhkit-python/api.qc.html). The data file used in this example is stored in the [\\\\\\\\MHKiT\\\\\\\\examples\\\\\\\\data](https://github.com/MHKiT-Software/MHKiT-Python/tree/main/examples/data) directory.\n", "\n", "Start by importing the necessary Python packages and MHKiT modules." ] @@ -438,7 +438,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "base", "language": "python", "name": "python3" }, diff --git a/examples/river_example.ipynb b/examples/river_example.ipynb index 5166070f3..964b14048 100644 --- a/examples/river_example.ipynb +++ b/examples/river_example.ipynb @@ -8,7 +8,7 @@ "source": [ "# MHKiT River Module\n", "\n", - "The following example will familiarize the user with the [MHKIT river module](https://mhkit-software.github.io/MHKiT/mhkit-python/api.river.html) by stepping through the calculation of annual energy produced for one turbine in the Tanana River near Nenana, Alaska. The data file used in this example is retrieved from the USGS website, a local version of the data is stored in the [\\\\\\\\MHKiT\\\\\\\\examples\\\\\\\\data](https://github.com/MHKiT-Software/MHKiT-Python/tree/master/examples/data) directory.\n", + "The following example will familiarize the user with the [MHKIT river module](https://mhkit-software.github.io/MHKiT/mhkit-python/api.river.html) by stepping through the calculation of annual energy produced for one turbine in the Tanana River near Nenana, Alaska. The data file used in this example is retrieved from the USGS website, a local version of the data is stored in the [\\\\\\\\MHKiT\\\\\\\\examples\\\\\\\\data](https://github.com/MHKiT-Software/MHKiT-Python/tree/main/examples/data) directory.\n", "\n", "Start by importing the necessary python packages and MHKiT module." ] @@ -357,7 +357,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "base", "language": "python", "name": "python3" }, diff --git a/examples/tidal_example.ipynb b/examples/tidal_example.ipynb index 4efe0e864..c062ac554 100644 --- a/examples/tidal_example.ipynb +++ b/examples/tidal_example.ipynb @@ -6,7 +6,7 @@ "source": [ "# MHKiT Tidal Module\n", "\n", - "The following example will familiarize the user with the [MHKiT tidal module](https://mhkit-software.github.io/MHKiT/mhkit-python/api.tidal.html) by stepping through the calculation of the velocity duration curve. The data file used in this example is stored in the [\\\\\\\\MHKiT\\\\\\\\examples\\\\\\\\data](https://github.com/MHKiT-Software/MHKiT-Python/tree/master/examples/data) directory.\n", + "The following example will familiarize the user with the [MHKiT tidal module](https://mhkit-software.github.io/MHKiT/mhkit-python/api.tidal.html) by stepping through the calculation of the velocity duration curve. The data file used in this example is stored in the [\\\\\\\\MHKiT\\\\\\\\examples\\\\\\\\data](https://github.com/MHKiT-Software/MHKiT-Python/tree/main/examples/data) directory.\n", "\n", "Start by importing the necessary MHKiT module." ] @@ -376,7 +376,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": "base", "language": "python", "name": "python3" }, @@ -391,11 +391,6 @@ "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.11.7" - }, - "vscode": { - "interpreter": { - "hash": "1b38577481a8c337d860514619746143ecc67292e11e5807b52b737c5351e332" - } } }, "nbformat": 4,