pyproject.toml

[build-system]
requires = [
    "setuptools>=45.0",
    "setuptools_scm[toml]>=6.2",
    "wheel>=0.38.1",
]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
write_to = "src/subscript/version.py"

[project]
name = "subscript"
description = "Equinor's collection of subsurface reservoir modelling scripts"
readme = "README.md"
requires-python = ">=3.8"
license = { file = "LICENSE" }
authors = [
    { name = "Equinor", email = "rnyb@equinor.com" },
]
keywords = ["energy", "subsurface", "reservoir", "scientific", "engineering"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Software Development :: Libraries",
    "Topic :: Utilities",
    "Operating System :: POSIX :: Linux",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Natural Language :: English",
    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
]
dynamic = ["version"]
dependencies = [
    "resdata",
    "res2df",
    "ert",
    "ert>=10.2.0b13",
    "fmu-tools",
    "grid3d_maps",
    "matplotlib",
    "numpy<2",
    "opm>=2023.04",
    "pandas",
    "pyscal",
    "pyyaml",
    "rips",
    "scipy",
    "seaborn",
    "segyio",
    "shapely",
    "xlrd",
    "xtgeo",
]

[project.optional-dependencies]
tests = [
    "mypy",
    "pytest",
    "pytest-cov",
    "pytest-mock",
    "pytest-xdist",
    "rstcheck",
    "rstcheck-core",
    "ruff",
    "types-Jinja2",
    "types-PyYAML",
    "types-python-dateutil",
]
docs = [
    "autoapi",
    "sphinx",
    "sphinx-argparse",
    "sphinx-autodoc-typehints<2.4",
    "sphinx-copybutton",
    "sphinx-togglebutton",
    "sphinx_rtd_theme",
]

[project.urls]
Homepage = "https://github.com/equinor/subscript"
Repository = "https://github.com/equinor/subscript"
Documentation = "https://equinor.github.io/subscript"

[project.scripts]
bjobsusers = "subscript.bjobsusers.bjobsusers:main"
casegen_upcars = "subscript.casegen_upcars.casegen_upcars:main"
check_swatinit = "subscript.check_swatinit.check_swatinit:main"
convert_grid_format = "subscript.convert_grid_format.convert_grid_format:main"
csv2ofmvol = "subscript.csv2ofmvol.csv2ofmvol:main"
csv_merge = "subscript.csv_merge.csv_merge:main"
csv_stack = "subscript.csv_stack.csv_stack:main"
eclcompress = "subscript.eclcompress.eclcompress:main"
ecldiff2roff = "subscript.ecldiff2roff.ecldiff2roff:main"
fmu_copy_revision = "subscript.fmu_copy_revision.fmu_copy_revision:main"
fmuobs = "subscript.fmuobs.fmuobs:main"
grav_subs_maps = "subscript.grav_subs_maps.grav_subs_maps:main"
grav_subs_points = "subscript.grav_subs_points.grav_subs_points:main"
interp_relperm = "subscript.interp_relperm.interp_relperm:main"
merge_rft_ertobs = "subscript.merge_rft_ertobs.merge_rft_ertobs:main"
merge_unrst_files = "subscript.merge_unrst_files.merge_unrst_files:main"
ofmvol2csv = "subscript.ofmvol2csv.ofmvol2csv:main"
pack_sim = "subscript.pack_sim.pack_sim:main"
params2csv = "subscript.params2csv.params2csv:main"
presentvalue = "subscript.presentvalue.presentvalue:main"
prtvol2csv = "subscript.prtvol2csv.prtvol2csv:main"
restartthinner = "subscript.restartthinner.restartthinner:main"
ri_wellmod = "subscript.ri_wellmod.ri_wellmod:main"
rmsecl_volumetrics = "subscript.rmsecl_volumetrics.rmsecl_volumetrics:main"
sector2fluxnum = "subscript.sector2fluxnum.sector2fluxnum:main"
summaryplot = "subscript.summaryplot.summaryplot:main"
sw_model_utilities = "subscript.sw_model_utilities.sw_model_utilities:main"
sunsch = "subscript.sunsch.sunsch:main"
vfp2csv = "subscript.vfp2csv.vfp2csv:main"
welltest_dpds = "subscript.welltest_dpds.welltest_dpds:main"
field_statistics = "subscript.field_statistics.field_statistics:main"


[project.entry-points.ert]
subscript_jobs = "subscript.hook_implementations.jobs"
CsvMerge = "subscript.csv_merge.csv_merge"
CsvStack = "subscript.csv_stack.csv_stack"
FmuObs = "subscript.fmuobs.fmuobs"
Params2Csv = "subscript.params2csv.params2csv"
FieldStatistics = "subscript.field_statistics.field_statistics"

[tool.setuptools]
script-files = [
    "src/subscript/legacy/duf",
    "src/subscript/legacy/eclmanual",
    "src/subscript/legacy/ertwatch",
    "src/subscript/legacy/list_rms_usage",
    "src/subscript/legacy/nosim",
    "src/subscript/legacy/runeclipse",
]

[tool.mypy]
ignore_missing_imports = true

[tool.pylint]
# Module docstrings are not required, there are other means of documenting at
# that level in subscript
disable = "missing-module-docstring"

[tool.pytest.ini_options]
norecursedirs = [
    ".git",
    ".tox",
    ".env",
    "dist",
    "build",
    "opm-common",
]
addopts = "-ra --strict-markers --ignore=docs/conf.py --ignore=setup.py --ignore=.eggs"
markers = [
    "integration: Marks a test as an integration test",
    "plot: Marks a test as interactive, plots will flash to the screen",
    "ri_dev: A test using a dev version of ResInsight, skipped by default"
]

[tool.rstcheck]
ignore_directives = ["argparse", "automodule"]

[tool.ruff]
lint.ignore = [
    "C901",
]
lint.select = [
    "C",
    "E",
    "F",
    "I",
    "PIE",
    "Q",
    "RET",
    "RSE",
    "SIM",
    "W",
]
line-length = 88

[tool.ruff.lint.isort]
combine-as-imports = true