feat!: reimplement dtocean-economics

.gitattributes

@@ -4,3 +4,4 @@
 *.xcf filter=lfs diff=lfs merge=lfs -text
 *.svg filter=lfs diff=lfs merge=lfs -text
 *.xlsx filter=lfs diff=lfs merge=lfs -text
+*.nc filter=lfs diff=lfs merge=lfs -text

.github/workflows/release.yml

@@ -9,14 +9,15 @@ permissions:
   contents: read
 
 env:
-  DTOCEAN_CORE_DIR: packages/dtocean-core
-  DTOCEAN_QT_DIR: packages/dtocean-qt
+  DTOCEAN_DIR: packages/dtocean
   DTOCEAN_APP_DIR: packages/dtocean-app
-  DTOCEAN_HYDRODYNAMICS_DIR: packages/dtocean-hydrodynamics
+  DTOCEAN_CORE_DIR: packages/dtocean-core
   DTOCEAN_DOCS_DIR: packages/dtocean-docs
-  DTOCEAN_DIR: packages/dtocean
-  POLITE_CONFIG_DIR: packages/polite-config
+  DTOCEAN_ECONOMICS_DIR: packages/dtocean-economics
+  DTOCEAN_HYDRODYNAMICS_DIR: packages/dtocean-hydrodynamics
+  DTOCEAN_QT_DIR: packages/dtocean-qt
   MDO_ENGINE_DIR: packages/mdo-engine
+  POLITE_CONFIG_DIR: packages/polite-config
   RELEASING_REPO: DTOcean/dtocean
 
 jobs:
@@ -40,6 +41,8 @@ jobs:
       dtocean-app-commit_sha: ${{ steps.release-dtocean-app.outputs.commit_sha }}
       dtocean-hydrodynamics-released: ${{ steps.release-dtocean-hydrodynamics.outputs.released }}
       dtocean-hydrodynamics-commit_sha: ${{ steps.release-dtocean-hydrodynamics.outputs.commit_sha }}
+      dtocean-economics-released: ${{ steps.release-dtocean-economics.outputs.released }}
+      dtocean-economics-commit_sha: ${{ steps.release-dtocean-economics.outputs.commit_sha }}
       root-released: ${{ steps.release-root.outputs.released }}
       root-commit_sha: ${{ steps.release-root.outputs.commit_sha }}
       root-tag: ${{ steps.release-root.outputs.tag }}
@@ -131,6 +134,16 @@ jobs:
           push: ${{ github.repository == env.RELEASING_REPO }}
           vcs_release: false
 
+      - name: Release dtocean-economics
+        id: release-dtocean-economics
+        uses: python-semantic-release/python-semantic-release@v10.5.3
+        with:
+          commit: ${{ github.repository == env.RELEASING_REPO }}
+          directory: ${{ env.DTOCEAN_ECONOMICS_DIR }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          push: ${{ github.repository == env.RELEASING_REPO }}
+          vcs_release: false
+
       - name: Release root
         id: release-root
         uses: ./.github/actions/semantic-release-calver
@@ -587,6 +600,51 @@ jobs:
           packages-dir: ${{ env.DTOCEAN_HYDRODYNAMICS_DIR }}/dist
           verbose: true
 
+  publish-dtocean-economics:
+    runs-on: ubuntu-latest
+    needs: release
+    if: needs.release.outputs.dtocean-economics-released == 'true'
+    permissions:
+      id-token: write
+    defaults:
+      run:
+        working-directory: ${{ env.DTOCEAN_ECONOMICS_DIR }}
+    environment:
+      name: pypi
+      url: https://pypi.org/project/dtocean-economics/
+    steps:
+      - name: Setup | Checkout repository on commit sha
+        uses: actions/checkout@v6
+        with:
+          lfs: true
+          ref: ${{ needs.release.outputs.dtocean-economics-commit_sha }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2
+
+      - name: Install poetry-monoranger-plugin
+        shell: bash
+        run: |
+          poetry self add git+https://github.com/H0R5E/poetry-monoranger-plugin.git#include_groups
+
+      - name: Update Poetry configuration
+        run: poetry config virtualenvs.create false
+
+      - name: Package project
+        run: poetry build
+
+      - name: Publish package distributions to PyPI
+        if: ${{ github.repository == env.RELEASING_REPO }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: ${{ env.DTOCEAN_ECONOMICS_DIR }}/dist
+          verbose: true
+
   publish-docs:
     needs: release
     if: needs.release.outputs.root-released == 'true'

.github/workflows/test-dtocean-economics.yml

@@ -0,0 +1,95 @@
+name: dtocean-economics tests
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".codecov.yml"
+      - ".github/workflows/test-dtocean-economics.yml"
+      - "packages/dtocean-core/src/**"
+      - "packages/dtocean-economics/**"
+      - "poetry.lock"
+  pull_request:
+    branches:
+      - main
+    paths:
+      - ".codecov.yml"
+      - ".github/workflows/test-dtocean-economics.yml"
+      - "packages/dtocean-core/src/**"
+      - "packages/dtocean-economics/**"
+      - "poetry.lock"
+
+jobs:
+  pytest:
+    name: Unit tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+        python-version: ["3.14", "3.13", "3.12"]
+    defaults:
+      run:
+        working-directory: packages/dtocean-economics
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - name: Install package
+        uses: ./.github/actions/poetry-install
+        with:
+          groups: '["dtocean-economics", "test"]'
+          python-version: ${{ matrix.python-version }}
+      - name: Run tests
+        run: |
+          poetry run pytest
+  pytest-extras:
+    name: Unit tests with plugins
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+        python-version: ["3.13", "3.12"]
+    defaults:
+      run:
+        working-directory: packages/dtocean-economics
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - name: Git LFS Pull
+        run: git lfs pull -I packages/dtocean-economics
+      - name: Install package
+        uses: ./.github/actions/poetry-install
+        with:
+          groups: '["dtocean-core", "dtocean-economics", "test"]'
+          python-version: ${{ matrix.python-version }}
+      - name: Run tests
+        run: |
+          poetry run pytest -v --cov src --cov-report=xml tests
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          flags: dtocean-economics
+  audit:
+    name: Code audit
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: packages/dtocean-economics
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - name: Install package
+        uses: ./.github/actions/poetry-install
+        with:
+          groups: '["audit", "dtocean-core", "dtocean-economics"]'
+          python-version: 3.13
+      - name: Run ruff
+        run: |
+          poetry run ruff check --output-format github
+      - name: Run pyright
+        run: |
+          poetry run pyright src

README.md

@@ -22,16 +22,16 @@ marine renewable energy arrays.**
 DTOcean can calculate:
 
 - Optimal ocean energy converter (OEC) positioning
-- <s>Energy export infrastructure</s>
-- <s>Station keeping requirements based on OEC performance and site conditions</s>
-- <s>Installation planning with weather effects</s>
-- <s>Maintenance planning, simulating OEC downtime</s>
-- <s>Environmental impact assessment (experimental)</s>
+- <del>Energy export infrastructure</del>
+- <del>Station keeping requirements based on OEC performance and site conditions</del>
+- <del>Installation planning with weather effects</del>
+- <del>Maintenance planning, simulating OEC downtime</del>
+- <del>Environmental impact assessment (experimental)</del>
 
 And features include:
 
-- <s>A unique statistical approach to calculating levelized cost of energy (LCOE)</s>
-- <s>OEC reliability influenced at component level</s>
+- A unique statistical approach to calculating levelized cost of energy (LCOE)
+- <del>OEC reliability influenced at component level</del>
 - Graphical user interface
 - Persistent database
 

docs/index.rst

@@ -45,7 +45,7 @@
     - Station keeping designed for device and site conditions [#f2]_
     - Installation planning with weather effects [#f2]_
     - Maintenance needs and OEC downtime [#f2]_
-    - A unique statistical approach to LCOE [#f2]_
+    - A unique statistical approach to LCOE
     - Influence reliability at component level [#f2]_
     - Environmental impact assessment [#f1]_ [#f2]_
     - Graphical user interface
@@ -55,7 +55,7 @@
 
 .. only:: html
 
-    Loved and maintained by `Mathew Topper <mathew.topper@dataonlygreater.com>`_
+    Loved and maintained by `Mathew Topper <damm_horse@yahoo.co.uk>`_
     \@ `Data Only Greater <http://www.dataonlygreater.com>`_
 
 .. rubric:: Footnotes

packages/dtocean-economics/.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+  "[markdown]": {
+    "editor.formatOnSave": true,
+  },
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+      "source.organizeImports": "explicit"
+    },
+    "editor.defaultFormatter": "charliermarsh.ruff"
+  },
+  "[toml]": {
+    "editor.formatOnSave": true,
+  },
+  "ruff.configuration": "pyproject.toml",
+}

packages/dtocean-economics/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+<!-- version list -->
+
+## [2.0.0] - 2019-03-07
+
+### Added
+
+- Added main function which takes three dataframes, one for CAPEX, OPEX, and
+  energy plus the discount rate and returns a dictionary of results.
+- Added a preprocessing module which provides functions for preparing the
+  required dataframes and for calculating estimates to the inputs.
+
+### Changed
+
+- Reorganised the functions module to undertake all dataframe manipulation
+  work. The main function just collects any valid results.
+- Now considers multiple series for energy and OPEX, as per changes in
+  the dtocean-maintenance module. Returns summed, discounted values and LCOE
+  calculations for each series.
+
+## [1.0.0] - 2017-01-05
+
+### Added
+
+- Initial import of dtocean-economics from SETIS.