fmu-pem 0.0.1__tar.gz

fmu_pem-0.0.1/.github/workflows/build_test_deploy.yml

@@ -0,0 +1,107 @@
+name: Build, test and (if release) deploy
+on:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - published
+  pull_request:
+
+jobs:
+  build:
+    name: "Python ${{ matrix.python-version }}"
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[tests]
+
+#      - name: Run ruff format
+#        run: ruff format . --diff
+
+      - name: Run ruff check
+        run: ruff check .
+
+      - name: Test with pytest
+        run: pytest
+
+      - name: Build a binary wheel and a source tarball
+        if: github.event_name == 'release'
+        run: |
+          pip install build
+          export SETUPTOOLS_SCM_PRETEND_VERSION_FOR_FMU_PEM=$GITHUB_REF_NAME
+          python -m build
+
+      - name: Upload artifact
+        if: github.event_name == 'release'
+        uses: actions/upload-artifact@v4
+        with:
+          name: Python dist
+          path: dist/
+
+      - name: Build configuration file user interface
+        working-directory: ./user-interface-config
+        run: |
+          npm ci
+          npm run create-json-schema
+          npm run build
+
+      - name: 📚 Update GitHub pages
+        # Update on merge to main
+        if: github.ref_name == 'main'
+        run: |
+          # Move the built documentation out of working directory, in order to delete everything else afterwards
+          cp -R ./user-interface-config/dist ../dist
+
+          git config --local user.email "fmu-pem-github-action"
+          git config --local user.name "fmu-pem-github-action"
+          git fetch origin gh-pages
+          git checkout -f --track origin/gh-pages
+          git clean -f -f -d -x
+          git rm -r *
+
+          cp -R ../dist/* .
+
+          git add .
+
+          if git diff-index --quiet HEAD; then
+            echo "No changes in documentation. Skip documentation deploy."
+          else
+            git commit -m "Update Github Pages"
+            git push "https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git" gh-pages
+          fi
+
+  deploy:
+    name: Upload release to PyPI
+    if: github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fmu-pem
+    permissions:
+      id-token: write  # required for Trusted Publishing to PyPI
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: Python dist
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

fmu_pem-0.0.1/.gitignore

@@ -0,0 +1,16 @@
+/.venv/
+/.vscode/
+# Local debug scripts etc
+Notebooks_and_scripts/
+Notebooks/
+.env
+.idea/
+/build/
+/dist/
+/src/fmu_pem.egg-info/
+**/__pycache__/
+src/fmu/pem/version.py
+
+# npm and node relevant build files
+node_modules
+dist

fmu_pem-0.0.1/ERT/run_pem.ert

@@ -0,0 +1,41 @@
+-- This script is run for test purpose of the PEM alone, whereas the PEM is normally run as part of
+-- a workflow that will produce its input files. The creation of directories and copying of input
+-- files may not be needed in a run where the PEM is just one part of a longer workflow.
+-- The model parameter directories ../../sim2seis/model is used by the PEM and the sim2seis workflows
+-- and copying of this directory may not be included in other ERT setup files
+-- HFLE/2025
+
+DEFINE <USER> $USER
+DEFINE <SCRATCH> /scratch/fmu
+DEFINE <CONFIG_PATH> /private/hfle/drogon_hfle/dev/rms/model
+
+NUM_REALIZATIONS 1
+RUNPATH     <SCRATCH>/<USER>/fmu_sim2seis_pem/realization-<IENS>/iter-<ITER>
+
+-- Copy required input files for the PEM, directories are automatically created by COPY_FILE
+FORWARD_MODEL COPY_FILE(<FROM>=<CONFIG_PATH>/../../fmuconfig/output/global_variables.yml,      <TO>=<RUNPATH>/fmuconfig/output/global_variables.yml)
+FORWARD_MODEL COPY_FILE(<FROM>=<CONFIG_PATH>/../../fmuconfig/output/global_variables_pred.yml, <TO>=<RUNPATH>/fmuconfig/output/global_variables_pred.yml)
+FORWARD_MODEL COPY_FILE(<FROM>=<CONFIG_PATH>/../../sim2seis/input/pem/ECLIPSE.EGRID,           <TO>=<RUNPATH>/sim2seis/input/pem/ECLIPSE.EGRID)
+FORWARD_MODEL COPY_FILE(<FROM>=<CONFIG_PATH>/../../sim2seis/input/pem/ECLIPSE.INIT,            <TO>=<RUNPATH>/sim2seis/input/pem/ECLIPSE.INIT)
+FORWARD_MODEL COPY_FILE(<FROM>=<CONFIG_PATH>/../../sim2seis/input/pem/ECLIPSE.UNRST,           <TO>=<RUNPATH>/sim2seis/input/pem/ECLIPSE.UNRST)
+FORWARD_MODEL COPY_FILE(<FROM>=<CONFIG_PATH>/../../sim2seis/input/pem/export_grid.roff,      <TO>=<RUNPATH>/sim2seis/input/pem/export_grid.roff)
+FORWARD_MODEL COPY_FILE(<FROM>=<CONFIG_PATH>/../../sim2seis/input/pem/export_prop.roff,      <TO>=<RUNPATH>/sim2seis/input/pem/export_prop.roff)
+
+-- Copy all model files in ../../sim2seis/model for flexibility. The PEM .yml file (new_pem_config.yml) is
+-- always required, .pkl model files are required if tmatrix model is used in the PEM
+FORWARD_MODEL COPY_DIRECTORY(<FROM>=<CONFIG_PATH>/../../sim2seis/model, <TO>=<RUNPATH>/sim2seis)
+
+-- Create output directories for input to seismic_forward and for QC/visualization of PEM results
+FORWARD_MODEL MAKE_DIRECTORY(<DIRECTORY> = <RUNPATH>/sim2seis/output/pem)
+FORWARD_MODEL MAKE_DIRECTORY(<DIRECTORY> = <RUNPATH>/share/results/grids)
+
+-- Create start directory
+FORWARD_MODEL MAKE_DIRECTORY(<DIRECTORY> = <RUNPATH>/rms/model)
+
+-- PEM parameter setting
+DEFINE <PEM_STARTDIR> <RUNPATH>/rms/model
+DEFINE <RELPATH_PEM> <RUNPATH>/sim2seis/model
+DEFINE <PEM_CONFIG_FILE_NAME> new_pem_config.yml
+
+-- Run the PEM
+FORWARD_MODEL PEM(<START_DIR>=<PEM_STARTDIR>, <CONFIG_DIR>=<RELPATH_PEM>, <CONFIG_FILE>=<PEM_CONFIG_FILE_NAME>)