fmu-sumo-explorer 3.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- fmu_sumo_explorer-3.0.0/.github/dependabot.yml +32 -0
- fmu_sumo_explorer-3.0.0/.github/pull_request_template.md +15 -0
- fmu_sumo_explorer-3.0.0/.github/workflows/build_docs.yaml +35 -0
- fmu_sumo_explorer-3.0.0/.github/workflows/check_formatting.yml +30 -0
- fmu_sumo_explorer-3.0.0/.github/workflows/publish_release.yaml +78 -0
- fmu_sumo_explorer-3.0.0/.github/workflows/release.yaml +31 -0
- fmu_sumo_explorer-3.0.0/.github/workflows/run_tests.yaml +73 -0
- fmu_sumo_explorer-3.0.0/.gitignore +115 -0
- fmu_sumo_explorer-3.0.0/.pre-commit-config.yaml +16 -0
- fmu_sumo_explorer-3.0.0/.readthedocs.yml +16 -0
- fmu_sumo_explorer-3.0.0/.release-please-manifest.json +3 -0
- fmu_sumo_explorer-3.0.0/CHANGELOG.md +19 -0
- fmu_sumo_explorer-3.0.0/CONTRIBUTING.md +45 -0
- fmu_sumo_explorer-3.0.0/LICENSE +201 -0
- fmu_sumo_explorer-3.0.0/PKG-INFO +272 -0
- fmu_sumo_explorer-3.0.0/README.md +33 -0
- fmu_sumo_explorer-3.0.0/SECURITY.md +18 -0
- fmu_sumo_explorer-3.0.0/compat/pyproject.toml +45 -0
- fmu_sumo_explorer-3.0.0/docs/_static/equinor-logo.png +0 -0
- fmu_sumo_explorer-3.0.0/docs/_static/equinor-logo2.jpg +0 -0
- fmu_sumo_explorer-3.0.0/docs/_static/equinor_logo.jpg +0 -0
- fmu_sumo_explorer-3.0.0/docs/_static/equinor_logo_only.jpg +0 -0
- fmu_sumo_explorer-3.0.0/docs/_templates/layout.html +17 -0
- fmu_sumo_explorer-3.0.0/docs/conf.py +86 -0
- fmu_sumo_explorer-3.0.0/docs/explorer.rst +637 -0
- fmu_sumo_explorer-3.0.0/docs/index.rst +19 -0
- fmu_sumo_explorer-3.0.0/examples/dev/explorer2.ipynb +548 -0
- fmu_sumo_explorer-3.0.0/examples/dev/grids-and-properties.ipynb +312 -0
- fmu_sumo_explorer-3.0.0/examples/dev/metrics.ipynb +255 -0
- fmu_sumo_explorer-3.0.0/examples/dev/table-aggregation.ipynb +234 -0
- fmu_sumo_explorer-3.0.0/examples/dev/tags.ipynb +267 -0
- fmu_sumo_explorer-3.0.0/examples/fmu-sumo-user-guide.ipynb +780 -0
- fmu_sumo_explorer-3.0.0/pyproject.toml +81 -0
- fmu_sumo_explorer-3.0.0/release-please-config.json +9 -0
- fmu_sumo_explorer-3.0.0/setup.cfg +4 -0
- fmu_sumo_explorer-3.0.0/src/fmu/__init__.py +2 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/__init__.py +13 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/_version.py +24 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/cache.py +39 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/explorer.py +94 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/filters.py +34 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/__init__.py +19 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/_child.py +212 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/_document.py +79 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/_metrics.py +326 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/_search_context.py +2305 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/case.py +112 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/cases.py +21 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/cpgrid.py +79 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/cpgrid_property.py +84 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/cube.py +68 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/dictionary.py +43 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/ensemble.py +96 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/ensembles.py +25 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/polygons.py +53 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/realization.py +87 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/realizations.py +25 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/surface.py +54 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/objects/table.py +146 -0
- fmu_sumo_explorer-3.0.0/src/fmu/sumo/explorer/timefilter.py +204 -0
- fmu_sumo_explorer-3.0.0/src/fmu_sumo_explorer.egg-info/PKG-INFO +272 -0
- fmu_sumo_explorer-3.0.0/src/fmu_sumo_explorer.egg-info/SOURCES.txt +69 -0
- fmu_sumo_explorer-3.0.0/src/fmu_sumo_explorer.egg-info/dependency_links.txt +1 -0
- fmu_sumo_explorer-3.0.0/src/fmu_sumo_explorer.egg-info/requires.txt +35 -0
- fmu_sumo_explorer-3.0.0/src/fmu_sumo_explorer.egg-info/scm_file_list.json +65 -0
- fmu_sumo_explorer-3.0.0/src/fmu_sumo_explorer.egg-info/scm_version.json +8 -0
- fmu_sumo_explorer-3.0.0/src/fmu_sumo_explorer.egg-info/top_level.txt +1 -0
- fmu_sumo_explorer-3.0.0/tests/conftest.py +14 -0
- fmu_sumo_explorer-3.0.0/tests/context.py +25 -0
- fmu_sumo_explorer-3.0.0/tests/test_explorer.py +502 -0
- fmu_sumo_explorer-3.0.0/tests/test_objects_table.py +49 -0
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# To get started with Dependabot version updates, you'll need to specify which
|
|
2
|
+
# package ecosystems to update and where the package manifests are located.
|
|
3
|
+
# Please see the documentation for all configuration options:
|
|
4
|
+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
|
|
5
|
+
|
|
6
|
+
version: 2
|
|
7
|
+
updates:
|
|
8
|
+
- package-ecosystem: "pip"
|
|
9
|
+
directory: "/"
|
|
10
|
+
target-branch: "main"
|
|
11
|
+
schedule:
|
|
12
|
+
interval: "daily"
|
|
13
|
+
groups:
|
|
14
|
+
python-minor-patch:
|
|
15
|
+
patterns:
|
|
16
|
+
- "*"
|
|
17
|
+
update-types:
|
|
18
|
+
- "minor"
|
|
19
|
+
- "patch"
|
|
20
|
+
|
|
21
|
+
- package-ecosystem: "github-actions"
|
|
22
|
+
directory: "/"
|
|
23
|
+
target-branch: "main"
|
|
24
|
+
schedule:
|
|
25
|
+
interval: "monthly"
|
|
26
|
+
groups:
|
|
27
|
+
all-actions:
|
|
28
|
+
patterns:
|
|
29
|
+
- "*"
|
|
30
|
+
update-types:
|
|
31
|
+
- "minor"
|
|
32
|
+
- "patch"
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
## Issue
|
|
2
|
+
_Link to the issue resolved by this PR._
|
|
3
|
+
|
|
4
|
+
## Description
|
|
5
|
+
_Description of the approach taken to solve the issue._
|
|
6
|
+
|
|
7
|
+
## How to test
|
|
8
|
+
_How to verify the changes._
|
|
9
|
+
|
|
10
|
+
## Checklist
|
|
11
|
+
- [ ] No redundant `print()` statements, commented-out code, or other remnants from the development 👀
|
|
12
|
+
- [ ] New/refactored code is following same conventions as the rest of the code base 🧬
|
|
13
|
+
- [ ] New/refactored code is tested ⚙
|
|
14
|
+
- [ ] Documentation has been updated 🧾
|
|
15
|
+
- [ ] Commits are semantic ✅
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# build documentation
|
|
2
|
+
# Deploy of doc is configured from ReadTheDocs
|
|
3
|
+
name: Build docs for fmu-sumo
|
|
4
|
+
|
|
5
|
+
on:
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main, docs]
|
|
8
|
+
push:
|
|
9
|
+
branches: [main, docs]
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
build_pywheels:
|
|
13
|
+
name: Build docs with Python ${{ matrix.python-version }} on ${{ matrix.os }}
|
|
14
|
+
permissions:
|
|
15
|
+
contents: read
|
|
16
|
+
id-token: write
|
|
17
|
+
runs-on: ${{ matrix.os }}
|
|
18
|
+
strategy:
|
|
19
|
+
matrix:
|
|
20
|
+
python-version: ["3.12"]
|
|
21
|
+
os: [ubuntu-latest]
|
|
22
|
+
|
|
23
|
+
steps:
|
|
24
|
+
- uses: actions/checkout@v7.0.1
|
|
25
|
+
|
|
26
|
+
- name: Set up Python
|
|
27
|
+
uses: actions/setup-python@v7.1.0
|
|
28
|
+
with:
|
|
29
|
+
python-version: ${{ matrix.python-version }}
|
|
30
|
+
|
|
31
|
+
- name: Install and build docs
|
|
32
|
+
run: |
|
|
33
|
+
pip install pip -U && pip install wheel -U
|
|
34
|
+
pip install .[docs]
|
|
35
|
+
sphinx-build docs build/sphinx/html
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
name: Check formatting and linting
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
push: { branches: [main] }
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
ruff-check:
|
|
9
|
+
name: Run ruff lint and format checks
|
|
10
|
+
permissions:
|
|
11
|
+
contents: read
|
|
12
|
+
id-token: write
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
|
|
15
|
+
steps:
|
|
16
|
+
- uses: actions/checkout@v7.0.1
|
|
17
|
+
|
|
18
|
+
- uses: actions/setup-python@v7.1.0
|
|
19
|
+
with:
|
|
20
|
+
python-version: "3.12"
|
|
21
|
+
cache: "pip"
|
|
22
|
+
|
|
23
|
+
- name: Installing dependencies
|
|
24
|
+
run: pip install ruff
|
|
25
|
+
|
|
26
|
+
- name: Run ruff lint
|
|
27
|
+
run: ruff check .
|
|
28
|
+
|
|
29
|
+
- name: Run ruff format
|
|
30
|
+
run: ruff format . --check
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
name: publish-release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types:
|
|
6
|
+
- published
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build:
|
|
10
|
+
name: Build and verify PyPI distributions
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v7.0.1
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0
|
|
18
|
+
|
|
19
|
+
- uses: actions/setup-python@v7.1.0
|
|
20
|
+
with:
|
|
21
|
+
python-version: "3.12"
|
|
22
|
+
|
|
23
|
+
- name: Build both packages
|
|
24
|
+
run: |
|
|
25
|
+
python -m pip install --upgrade build twine
|
|
26
|
+
python -m build --outdir dist/explorer
|
|
27
|
+
cp LICENSE compat/LICENSE
|
|
28
|
+
python -m build --outdir dist/compat compat
|
|
29
|
+
python -m twine check --strict dist/explorer/* dist/compat/*
|
|
30
|
+
|
|
31
|
+
- name: Verify release versions
|
|
32
|
+
run: |
|
|
33
|
+
python - <<'PY'
|
|
34
|
+
from importlib.metadata import distributions
|
|
35
|
+
from pathlib import Path
|
|
36
|
+
|
|
37
|
+
def wheel_metadata(directory):
|
|
38
|
+
wheel, = Path(directory).glob("*.whl")
|
|
39
|
+
distribution, = distributions(path=[str(wheel)])
|
|
40
|
+
return distribution.metadata
|
|
41
|
+
|
|
42
|
+
explorer_version = wheel_metadata("dist/explorer")["Version"]
|
|
43
|
+
alias = wheel_metadata("dist/compat")
|
|
44
|
+
if alias["Version"] != explorer_version:
|
|
45
|
+
raise SystemExit(f"Package versions differ: {alias['Version']} != {explorer_version}")
|
|
46
|
+
if f"fmu-sumo-explorer=={explorer_version}" not in alias.get_all("Requires-Dist", []):
|
|
47
|
+
raise SystemExit(f"fmu-sumo must pin fmu-sumo-explorer=={explorer_version}")
|
|
48
|
+
PY
|
|
49
|
+
|
|
50
|
+
- uses: actions/upload-artifact@v4
|
|
51
|
+
with:
|
|
52
|
+
name: pypi-distributions
|
|
53
|
+
path: dist/
|
|
54
|
+
if-no-files-found: error
|
|
55
|
+
|
|
56
|
+
publish:
|
|
57
|
+
name: Publish both distributions to PyPI
|
|
58
|
+
needs: build
|
|
59
|
+
permissions:
|
|
60
|
+
contents: read
|
|
61
|
+
id-token: write
|
|
62
|
+
environment: production
|
|
63
|
+
runs-on: ubuntu-latest
|
|
64
|
+
steps:
|
|
65
|
+
- uses: actions/download-artifact@v4
|
|
66
|
+
with:
|
|
67
|
+
name: pypi-distributions
|
|
68
|
+
path: dist
|
|
69
|
+
|
|
70
|
+
- name: Publish fmu-sumo-explorer
|
|
71
|
+
uses: pypa/gh-action-pypi-publish@v1.14.3
|
|
72
|
+
with:
|
|
73
|
+
packages-dir: dist/explorer/
|
|
74
|
+
|
|
75
|
+
- name: Publish fmu-sumo compatibility package
|
|
76
|
+
uses: pypa/gh-action-pypi-publish@v1.14.3
|
|
77
|
+
with:
|
|
78
|
+
packages-dir: dist/compat/
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
name: 🔖 Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: write
|
|
10
|
+
pull-requests: write
|
|
11
|
+
issues: write
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
release-please:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- name: Generate GitHub App token
|
|
18
|
+
id: app-token
|
|
19
|
+
uses: actions/create-github-app-token@v3
|
|
20
|
+
with:
|
|
21
|
+
client-id: ${{ vars.GH_CLIENT_ID }}
|
|
22
|
+
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
|
|
23
|
+
owner: ${{ github.repository_owner }}
|
|
24
|
+
|
|
25
|
+
- name: Release with release please
|
|
26
|
+
uses: googleapis/release-please-action@v5.0.0
|
|
27
|
+
id: release
|
|
28
|
+
with:
|
|
29
|
+
token: ${{ steps.app-token.outputs.token }}
|
|
30
|
+
config-file: release-please-config.json
|
|
31
|
+
manifest-file: .release-please-manifest.json
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
name: Build and test fmu-sumo
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
branches: [main]
|
|
6
|
+
workflow_dispatch:
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build_distributions:
|
|
10
|
+
name: Build and verify PyPI distributions
|
|
11
|
+
permissions:
|
|
12
|
+
contents: read
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v7.0.1
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0
|
|
18
|
+
|
|
19
|
+
- uses: actions/setup-python@v7.1.0
|
|
20
|
+
with:
|
|
21
|
+
python-version: "3.12"
|
|
22
|
+
|
|
23
|
+
- name: Build both packages
|
|
24
|
+
run: |
|
|
25
|
+
python -m pip install --upgrade build twine
|
|
26
|
+
python -m build --outdir dist/explorer
|
|
27
|
+
cp LICENSE compat/LICENSE
|
|
28
|
+
python -m build --outdir dist/compat compat
|
|
29
|
+
python -m twine check --strict dist/explorer/* dist/compat/*
|
|
30
|
+
|
|
31
|
+
build_pywheels:
|
|
32
|
+
name: PY ${{ matrix.python-version }} on ${{ matrix.os }}
|
|
33
|
+
runs-on: ${{ matrix.os }}
|
|
34
|
+
strategy:
|
|
35
|
+
matrix:
|
|
36
|
+
python-version: ["3.11", "3.12"]
|
|
37
|
+
os: [ubuntu-latest, windows-latest, macos-15]
|
|
38
|
+
exclude:
|
|
39
|
+
- os: windows-latest
|
|
40
|
+
python-version: "3.11"
|
|
41
|
+
permissions:
|
|
42
|
+
contents: read
|
|
43
|
+
id-token: write
|
|
44
|
+
|
|
45
|
+
steps:
|
|
46
|
+
- uses: actions/checkout@v7.0.1
|
|
47
|
+
|
|
48
|
+
- name: Azure Login
|
|
49
|
+
uses: Azure/login@v3.1.0
|
|
50
|
+
with:
|
|
51
|
+
client-id: f96c150d-cacf-4257-9cc9-54b2c68ec4ce
|
|
52
|
+
tenant-id: 3aa4a235-b6e2-48d5-9195-7fcf05b459b0
|
|
53
|
+
subscription-id: 87897772-fb27-495f-ae40-486a2df57baa
|
|
54
|
+
|
|
55
|
+
- name: Set up Python
|
|
56
|
+
uses: actions/setup-python@v7.1.0
|
|
57
|
+
with:
|
|
58
|
+
python-version: ${{ matrix.python-version }}
|
|
59
|
+
|
|
60
|
+
- name: Install fmu-sumo
|
|
61
|
+
run: >
|
|
62
|
+
python -m pip install --upgrade pip &&
|
|
63
|
+
python -m pip install .[test]
|
|
64
|
+
- name: Run tests
|
|
65
|
+
shell: bash
|
|
66
|
+
run: |
|
|
67
|
+
az --version
|
|
68
|
+
az account list
|
|
69
|
+
pip show sumo-wrapper-python
|
|
70
|
+
access_token=$(az account get-access-token --scope api://88d2b022-3539-4dda-9e66-853801334a86/.default --query accessToken --output tsv)
|
|
71
|
+
export ACCESS_TOKEN=$access_token
|
|
72
|
+
|
|
73
|
+
pytest -s --timeout=300
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*ipynb_checkpoints*
|
|
4
|
+
*.py[cod]
|
|
5
|
+
*$py.class
|
|
6
|
+
|
|
7
|
+
# Distribution / packaging
|
|
8
|
+
.Python
|
|
9
|
+
build/
|
|
10
|
+
develop-eggs/
|
|
11
|
+
dist/
|
|
12
|
+
downloads/
|
|
13
|
+
eggs/
|
|
14
|
+
.eggs/
|
|
15
|
+
lib/
|
|
16
|
+
lib64/
|
|
17
|
+
parts/
|
|
18
|
+
sdist/
|
|
19
|
+
var/
|
|
20
|
+
wheels/
|
|
21
|
+
pip-wheel-metadata/
|
|
22
|
+
share/python-wheels/
|
|
23
|
+
*.egg-info/
|
|
24
|
+
.installed.cfg
|
|
25
|
+
*.egg
|
|
26
|
+
MANIFEST
|
|
27
|
+
_version.py
|
|
28
|
+
/compat/LICENSE
|
|
29
|
+
|
|
30
|
+
# PyInstaller
|
|
31
|
+
# Usually these files are written by a python script from a template
|
|
32
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
33
|
+
*.manifest
|
|
34
|
+
*.spec
|
|
35
|
+
|
|
36
|
+
# Installer logs
|
|
37
|
+
pip-log.txt
|
|
38
|
+
pip-delete-this-directory.txt
|
|
39
|
+
|
|
40
|
+
# Unit test / coverage reports
|
|
41
|
+
htmlcov/
|
|
42
|
+
.tox/
|
|
43
|
+
.nox/
|
|
44
|
+
.coverage
|
|
45
|
+
.coverage.*
|
|
46
|
+
.cache
|
|
47
|
+
nosetests.xml
|
|
48
|
+
coverage.xml
|
|
49
|
+
*.cover
|
|
50
|
+
*.py,cover
|
|
51
|
+
.hypothesis/
|
|
52
|
+
.pytest_cache/
|
|
53
|
+
|
|
54
|
+
# Sphinx documentation
|
|
55
|
+
docs/_build/
|
|
56
|
+
docs/apiref/
|
|
57
|
+
|
|
58
|
+
# PyBuilder
|
|
59
|
+
target/
|
|
60
|
+
|
|
61
|
+
# Jupyter Notebook
|
|
62
|
+
.ipynb_checkpoints
|
|
63
|
+
|
|
64
|
+
# IPython
|
|
65
|
+
profile_default/
|
|
66
|
+
ipython_config.py
|
|
67
|
+
|
|
68
|
+
# pyenv
|
|
69
|
+
.python-version
|
|
70
|
+
|
|
71
|
+
# pipenv
|
|
72
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
73
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
74
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
75
|
+
# install all needed dependencies.
|
|
76
|
+
#Pipfile.lock
|
|
77
|
+
|
|
78
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
|
|
79
|
+
__pypackages__/
|
|
80
|
+
|
|
81
|
+
# Environments
|
|
82
|
+
.env
|
|
83
|
+
.venv
|
|
84
|
+
env/
|
|
85
|
+
venv/
|
|
86
|
+
ENV/
|
|
87
|
+
env.bak/
|
|
88
|
+
venv.bak/
|
|
89
|
+
_venv
|
|
90
|
+
|
|
91
|
+
# Rope project settings
|
|
92
|
+
.ropeproject
|
|
93
|
+
|
|
94
|
+
# mkdocs documentation
|
|
95
|
+
/site
|
|
96
|
+
|
|
97
|
+
# vscode
|
|
98
|
+
.vscode/
|
|
99
|
+
|
|
100
|
+
# pycharm
|
|
101
|
+
.idea
|
|
102
|
+
|
|
103
|
+
# setuptools_scm version
|
|
104
|
+
src/fmu/sumo/version.py
|
|
105
|
+
|
|
106
|
+
# local expermentation
|
|
107
|
+
testing.ipynb
|
|
108
|
+
# files generated during testing
|
|
109
|
+
*.csv
|
|
110
|
+
|
|
111
|
+
# emacs backup files
|
|
112
|
+
*~
|
|
113
|
+
|
|
114
|
+
# Ignore macOS system files
|
|
115
|
+
*.DS_Store
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: local
|
|
3
|
+
hooks:
|
|
4
|
+
- id: lint
|
|
5
|
+
name: Ruff Lint
|
|
6
|
+
description: Linting using ruff
|
|
7
|
+
entry: bash -c 'ruff check .'
|
|
8
|
+
language: system
|
|
9
|
+
stages: ["pre-commit", "pre-push"]
|
|
10
|
+
|
|
11
|
+
- id: format
|
|
12
|
+
name: Ruff Format
|
|
13
|
+
description: Formatting using ruff
|
|
14
|
+
entry: bash -c 'ruff format . --check'
|
|
15
|
+
language: system
|
|
16
|
+
stages: ["pre-commit", "pre-push"]
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [3.0.0](https://github.com/equinor/fmu-sumo-explorer/compare/v2.16.1...v3.0.0) (2026-11-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### ⚠ BREAKING CHANGES
|
|
7
|
+
|
|
8
|
+
* Existing installations of fmu-sumo that contain the library must uninstall it before installing fmu-sumo-explorer or the new fmu-sumo compatibility package. Python imports are unchanged.
|
|
9
|
+
|
|
10
|
+
### Features
|
|
11
|
+
|
|
12
|
+
* rename PyPI distribution to fmu-sumo-explorer ([#499](https://github.com/equinor/fmu-sumo-explorer/issues/499)) ([fb5c99a](https://github.com/equinor/fmu-sumo-explorer/commit/fb5c99a4199041696bdcb2edc903811528113f83))
|
|
13
|
+
|
|
14
|
+
## [2.16.1](https://github.com/equinor/fmu-sumo/compare/v2.16.0...v2.16.1) (2026-10-12)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Documentation
|
|
18
|
+
|
|
19
|
+
* add jupyter notebook for using tags ([#495](https://github.com/equinor/fmu-sumo/issues/495)) ([ff8b03f](https://github.com/equinor/fmu-sumo/commit/ff8b03f7b702821b64a577dcac070664172e2e62))
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# How to contribute to this repo
|
|
2
|
+
|
|
3
|
+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
|
|
4
|
+
|
|
5
|
+
- Reporting a bug
|
|
6
|
+
- Proposing new features
|
|
7
|
+
- Discussing the current state of the code
|
|
8
|
+
- Submitting a fix
|
|
9
|
+
|
|
10
|
+
This is how you should do it:
|
|
11
|
+
|
|
12
|
+
Use our [issue list](../../issues) to report a **bug** or **propose a new feature**, including
|
|
13
|
+
|
|
14
|
+
### Reporting a **bug report**
|
|
15
|
+
- A quick summary and/or background
|
|
16
|
+
- Steps to reproduce
|
|
17
|
+
- What actually happens
|
|
18
|
+
|
|
19
|
+
### Adding a **feature request**
|
|
20
|
+
- Brief description of the feature
|
|
21
|
+
- What problem/issue will this solve
|
|
22
|
+
- A sort of Definition of Done - "How should it look when finished"
|
|
23
|
+
|
|
24
|
+
### When submitting a fix using a Pull Request (PR)
|
|
25
|
+
- Fork this repository from GitHub
|
|
26
|
+
- After you have made the changes, create a pull request (PR)
|
|
27
|
+
|
|
28
|
+
We will review the pull request and if it is appropriate and there are no clashes or vulnerabilities, it will be merged to the main code.
|
|
29
|
+
|
|
30
|
+
## Packaging
|
|
31
|
+
|
|
32
|
+
Release Please updates `compat/pyproject.toml` in each release PR. Keep the
|
|
33
|
+
`x-release-please-version` markers on the alias version and dependency pins.
|
|
34
|
+
On release builds, `setuptools-scm` gets Explorer's version from the Git tag.
|
|
35
|
+
On ordinary PRs, the build-and-test workflow builds both packages without
|
|
36
|
+
requiring their versions to match. The publishing workflow runs only on
|
|
37
|
+
published GitHub releases. Before uploading to PyPI, it checks that both wheels
|
|
38
|
+
have the same version and that the alias pins that exact Explorer version.
|
|
39
|
+
|
|
40
|
+
To build the compatibility package locally with `build` installed:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
cp LICENSE compat/LICENSE
|
|
44
|
+
python -m build --outdir dist/compat compat
|
|
45
|
+
```
|