ert 16.0.9__py3-none-any.whl → 19.0.0rc2__py3-none-any.whl

everest/assets/everest_logo.svg

@@ -0,0 +1,406 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   viewBox="0 0 821.56887 232.52212"
+   version="1.1"
+   id="svg21"
+   sodipodi:docname="everest_logo.svg"
+   width="821.56885"
+   height="232.52213"
+   inkscape:version="1.4.2 (f4327f4, 2025-05-13)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview21"
+     pagecolor="#ffffff"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:zoom="3.1028704"
+     inkscape:cx="300.68932"
+     inkscape:cy="123.91752"
+     inkscape:window-width="5160"
+     inkscape:window-height="2126"
+     inkscape:window-x="2869"
+     inkscape:window-y="-11"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg21" />
+  <defs
+     id="defs14">
+    <style
+       id="style1">.j{fill:#fff;}.k{fill:url(#f);}.l{clip-path:url(#e);}.m{clip-path:url(#d);}.n{fill:url(#h);}.o{fill:none;}.p{clip-path:url(#i);}.q{fill:#002484;}.r{clip-path:url(#g);}</style>
+    <clipPath
+       id="d">
+      <rect
+         class="o"
+         width="1139.59"
+         height="233.91"
+         id="rect1"
+         x="0"
+         y="0" />
+    </clipPath>
+    <clipPath
+       id="e">
+      <path
+         class="o"
+         d="M 0,116.95 C 0,181.54 52.36,233.9 116.95,233.9 181.54,233.9 233.9,181.54 233.9,116.95 233.9,52.36 181.54,0 116.95,0 52.36,0 0,52.36 0,116.95"
+         id="path1" />
+    </clipPath>
+    <linearGradient
+       id="f"
+       x1="-386.98001"
+       y1="636.65997"
+       x2="-385.98001"
+       y2="636.65997"
+       gradientTransform="matrix(233.94,0,0,-233.94,90532.27,149060.04)"
+       gradientUnits="userSpaceOnUse">
+      <stop
+         offset="0"
+         stop-color="#ff1543"
+         id="stop1" />
+      <stop
+         offset=".23"
+         stop-color="#ff1845"
+         id="stop2" />
+      <stop
+         offset=".4"
+         stop-color="#ff214d"
+         id="stop3" />
+      <stop
+         offset=".56"
+         stop-color="#ff3159"
+         id="stop4" />
+      <stop
+         offset=".7"
+         stop-color="#ff486c"
+         id="stop5" />
+      <stop
+         offset=".83"
+         stop-color="#ff6583"
+         id="stop6" />
+      <stop
+         offset=".96"
+         stop-color="#ff89a0"
+         id="stop7" />
+      <stop
+         offset="1"
+         stop-color="#ff96aa"
+         id="stop8" />
+    </linearGradient>
+    <clipPath
+       id="g">
+      <path
+         class="o"
+         d="M 0.46,106.52 C 0.16,109.96 0,113.44 0,116.95 0,181.54 52.36,233.9 116.95,233.9 c 64.59,0 112.56,-48.08 116.68,-108.93 v -0.19 l -76.2,-56.36 v 41.29 L 76.77,49.88 Z"
+         id="path8" />
+    </clipPath>
+    <linearGradient
+       id="h"
+       x1="-386.98001"
+       y1="636.71997"
+       x2="-385.98001"
+       y2="636.71997"
+       gradientTransform="matrix(222.02,0,0,-222.02,85898.26,141510.45)"
+       gradientUnits="userSpaceOnUse">
+      <stop
+         offset="0"
+         stop-color="#123eb7"
+         id="stop9" />
+      <stop
+         offset=".05"
+         stop-color="#0e39ad"
+         id="stop10" />
+      <stop
+         offset=".19"
+         stop-color="#082f9a"
+         id="stop11" />
+      <stop
+         offset=".36"
+         stop-color="#03288d"
+         id="stop12" />
+      <stop
+         offset=".57"
+         stop-color="#002586"
+         id="stop13" />
+      <stop
+         offset="1"
+         stop-color="#002484"
+         id="stop14" />
+    </linearGradient>
+    <clipPath
+       id="i">
+      <circle
+         class="o"
+         cx="116.95"
+         cy="116.95"
+         r="116.95"
+         id="circle14" />
+    </clipPath>
+    <mask
+       maskUnits="userSpaceOnUse"
+       id="mask16">
+      <circle
+         cx="64.03392"
+         cy="64.03392"
+         fill="url(#radial-gradient)"
+         stroke-width="0"
+         id="circle16"
+         style="fill:#ffffff;fill-opacity:1"
+         r="63.74976" />
+    </mask>
+    <radialGradient
+       id="radial-gradient"
+       cx="64.03392"
+       cy="64.03392"
+       fx="49.353233"
+       fy="82.396118"
+       r="59.086895"
+       gradientUnits="userSpaceOnUse">
+      <stop
+         offset="0"
+         stop-color="#f5aba7"
+         id="stop1-0" />
+      <stop
+         offset=".217861041112723"
+         stop-color="#f4a8a5"
+         id="stop2-9" />
+      <stop
+         offset=".361136125615505"
+         stop-color="#f39f9f"
+         id="stop3-0" />
+      <stop
+         offset=".482893104808535"
+         stop-color="#f29094"
+         id="stop4-0" />
+      <stop
+         offset=".592650507232557"
+         stop-color="#ef7b86"
+         id="stop5-6" />
+      <stop
+         offset=".694335183107659"
+         stop-color="#ec5f73"
+         id="stop6-1" />
+      <stop
+         offset=".78871442354024"
+         stop-color="#e93e5d"
+         id="stop7-3" />
+      <stop
+         offset=".860573681175441"
+         stop-color="#e62048"
+         id="stop8-8" />
+    </radialGradient>
+    <clipPath
+       id="clippath">
+      <circle
+         cx="64.03392"
+         cy="64.03392"
+         r="64.03392"
+         fill="none"
+         stroke-width="0"
+         id="circle8" />
+    </clipPath>
+    <linearGradient
+       id="linear-gradient"
+       x1="32.965416"
+       y1="147.10043"
+       x2="93.746849"
+       y2="41.823895"
+       gradientUnits="userSpaceOnUse">
+      <stop
+         offset="0"
+         stop-color="#284899"
+         id="stop9-9" />
+      <stop
+         offset=".138867226110765"
+         stop-color="#273f87"
+         id="stop10-3" />
+      <stop
+         offset=".311629315711017"
+         stop-color="#26397a"
+         id="stop11-4" />
+      <stop
+         offset=".536330265490111"
+         stop-color="#263673"
+         id="stop12-4" />
+      <stop
+         offset="1"
+         stop-color="#263571"
+         id="stop13-6" />
+    </linearGradient>
+    <mask
+       maskUnits="userSpaceOnUse"
+       id="mask16-6">
+      <circle
+         cx="64.03392"
+         cy="64.03392"
+         fill="url(#radial-gradient)"
+         stroke-width="0"
+         id="circle16-6"
+         style="fill:#ffffff;fill-opacity:1"
+         r="63.74976" />
+    </mask>
+    <radialGradient
+       id="radial-gradient-1"
+       cx="64.03392"
+       cy="64.03392"
+       fx="49.353233"
+       fy="82.396118"
+       r="59.086895"
+       gradientUnits="userSpaceOnUse">
+      <stop
+         offset="0"
+         stop-color="#f5aba7"
+         id="stop1-0-8" />
+      <stop
+         offset=".217861041112723"
+         stop-color="#f4a8a5"
+         id="stop2-9-4" />
+      <stop
+         offset=".361136125615505"
+         stop-color="#f39f9f"
+         id="stop3-0-9" />
+      <stop
+         offset=".482893104808535"
+         stop-color="#f29094"
+         id="stop4-0-6" />
+      <stop
+         offset=".592650507232557"
+         stop-color="#ef7b86"
+         id="stop5-6-3" />
+      <stop
+         offset=".694335183107659"
+         stop-color="#ec5f73"
+         id="stop6-1-7" />
+      <stop
+         offset=".78871442354024"
+         stop-color="#e93e5d"
+         id="stop7-3-8" />
+      <stop
+         offset=".860573681175441"
+         stop-color="#e62048"
+         id="stop8-8-8" />
+    </radialGradient>
+    <clipPath
+       id="clippath-2">
+      <circle
+         cx="64.03392"
+         cy="64.03392"
+         r="64.03392"
+         fill="none"
+         stroke-width="0"
+         id="circle8-9" />
+    </clipPath>
+    <linearGradient
+       id="linear-gradient-1"
+       x1="32.965416"
+       y1="147.10043"
+       x2="93.746849"
+       y2="41.823895"
+       gradientUnits="userSpaceOnUse">
+      <stop
+         offset="0"
+         stop-color="#284899"
+         id="stop9-9-3" />
+      <stop
+         offset=".138867226110765"
+         stop-color="#273f87"
+         id="stop10-3-5" />
+      <stop
+         offset=".311629315711017"
+         stop-color="#26397a"
+         id="stop11-4-9" />
+      <stop
+         offset=".536330265490111"
+         stop-color="#263673"
+         id="stop12-4-8" />
+      <stop
+         offset="1"
+         stop-color="#263571"
+         id="stop13-6-4" />
+    </linearGradient>
+  </defs>
+  <g
+     id="a"
+     transform="translate(-0.25982526,-2.1642165)" />
+  <g
+     id="g1"
+     transform="translate(0,-51.351725)">
+    <polygon
+       class="q"
+       points="354.77,148.41 412.88,148.41 412.88,175.43 321.56,175.43 321.56,58.89 411.25,58.89 411.25,85.91 354.77,85.91 354.77,105.44 408.16,105.44 408.16,127.74 354.77,127.74 "
+       id="polygon14"
+       transform="matrix(0.68640799,0,0,0.68640799,39.345198,87.134883)" />
+    <polygon
+       class="q"
+       points="426.22,58.89 461.37,58.89 486.6,150.2 488.23,150.2 513.13,58.89 548.62,58.89 514.11,175.43 460.56,175.43 "
+       id="polygon15"
+       transform="matrix(0.68640799,0,0,0.68640799,39.345198,87.134883)" />
+    <polygon
+       class="q"
+       points="599.72,148.41 657.82,148.41 657.82,175.43 566.51,175.43 566.51,58.89 656.2,58.89 656.2,85.91 599.72,85.91 599.72,105.44 653.1,105.44 653.1,127.74 599.72,127.74 "
+       id="polygon16"
+       transform="matrix(0.68640799,0,0,0.68640799,39.345198,87.134883)" />
+    <g
+       class="m"
+       clip-path="url(#d)"
+       id="g18"
+       transform="matrix(0.68640799,0,0,0.68640799,39.345198,87.134883)">
+      <path
+         class="q"
+         d="M 678.81,175.43 V 58.89 h 58.76 c 28.48,0 47.36,15.95 47.36,39.72 0,19.04 -12.37,32.39 -29.3,35.48 l -1.3,0.33 34.34,41.02 h -38.25 l -28.97,-38.41 h -8.3 v 38.41 h -34.34 z m 34.34,-60.71 h 18.39 c 10.91,0 19.04,-5.86 19.04,-15.62 0,-9.76 -8.14,-15.46 -19.04,-15.46 h -18.39 v 31.09 z"
+         id="path16" />
+      <polygon
+         class="q"
+         points="839.78,148.41 897.89,148.41 897.89,175.43 806.58,175.43 806.58,58.89 896.26,58.89 896.26,85.91 839.78,85.91 839.78,105.44 893.17,105.44 893.17,127.74 839.78,127.74 "
+         id="polygon17" />
+      <path
+         class="q"
+         d="m 914.81,137.02 h 32.23 c 0.16,9.77 8.14,16.11 22.14,16.11 11.07,0 18.23,-4.07 18.23,-11.23 0,-8.46 -9.6,-10.42 -21.48,-12.04 -20.02,-2.77 -50.29,-5.21 -50.29,-35.16 0,-23.11 19.86,-38.09 50.62,-38.09 30.76,0 51.6,16.6 51.6,40.69 h -31.09 c 0,-10.26 -7.65,-16.11 -19.37,-16.11 -10.91,0 -17.42,4.56 -17.42,11.07 0,8.79 11.56,10.26 25.07,12.21 19.86,2.93 46.71,7.16 46.71,35.32 0,23.11 -21.32,38.09 -53.88,38.09 -32.56,0 -53.06,-16.76 -53.06,-40.85"
+         id="path17" />
+      <polygon
+         class="q"
+         points="1068.78,87.05 1032.32,87.05 1032.32,58.89 1139.59,58.89 1139.59,87.05 1103.13,87.05 1103.13,175.43 1068.78,175.43 "
+         id="polygon18" />
+    </g>
+  </g>
+  <g
+     id="g16"
+     mask="url(#mask16-6)"
+     transform="matrix(1.8237098,0,0,1.8237098,-0.5182265,-0.51822534)">
+    <circle
+       cx="64.03392"
+       cy="64.03392"
+       r="64.03392"
+       fill="url(#radial-gradient)"
+       stroke-width="0"
+       id="circle13"
+       style="fill:url(#radial-gradient-1)" />
+    <g
+       clip-path="url(#clippath-2)"
+       id="g15">
+      <g
+         id="g14">
+        <polygon
+           points="42.035928,128.06784 86.198552,128.06784 128.06784,128.06784 127.91906,68.32343 86.198552,37.46588 86.198552,60.074086 42.035928,27.309721 1.0004e-11,58.508567 0,128.06784 "
+           fill="url(#linear-gradient)"
+           stroke-width="0"
+           id="polygon13"
+           style="fill:url(#linear-gradient-1)" />
+        <polygon
+           points="86.198562,60.175133 86.198562,37.566934 70.870099,48.802914 "
+           fill="#ffffff"
+           stroke-width="0"
+           id="polygon14-0" />
+        <path
+           d="m 38.763237,67.759224 c 2.990335,-2.053995 4.951441,-5.497907 4.951441,-9.399859 l -8.579382,-5.901845 6.725446,-4.922761 -6.616443,-4.964692 6.791802,-5.143195 V 27.410768 L 0,58.609614 v 37.87583 z"
+           fill="#ffffff"
+           stroke-width="0"
+           id="path14" />
+      </g>
+    </g>
+  </g>
+</svg>

everest/bin/config_branch_script.py

@@ -2,15 +2,16 @@ import argparse
 from copy import deepcopy as copy
 from functools import partial
 from pathlib import Path
+from textwrap import dedent
 from typing import Any
 
-from ruamel.yaml import YAML
-
 from everest.bin.utils import setup_logging
 from everest.config import EverestConfig
 from everest.config_file_loader import load_yaml
 from everest.everest_storage import EverestStorage
 
+from .utils import ArgParseFormatter
+
 
 def _yaml_config(
     file_path: str, parser: argparse.ArgumentParser
@@ -23,23 +24,40 @@ def _yaml_config(
 
 def _build_args_parser() -> argparse.ArgumentParser:
     arg_parser = argparse.ArgumentParser(
-        description="Create new config file with updated controls "
-        "from specified simulation batch number\n"
-        "**Warning**: Previous simulation output folder will be overwritten"
-        " if it was placed outside the everest output folder",
+        description=dedent(
+            """
+            Create a configuration file with updated controls based on a
+            previous run.
+
+            The *everest branch* command reads an existing configuration and
+            creates a new configuration file, with initial control values taken
+            from a batch of a previous optimization run.
+
+            **Warning:** Do not remove the optimization output folder before
+            running the *branch* command or it will fail.
+
+            **Note:** The *branch* command does not provide true restart
+            functionality. The new config file merely sets new initial controls
+            defined by the given batch. Subsequent optimization runs will likely
+            produce slightly different results.
+            """
+        ),
+        formatter_class=ArgParseFormatter,
         usage="""everest branch <config_file> <new_config_file> -b #""",
     )
     arg_parser.add_argument(
         "config",
-        help="The path to the everest configuration file",
+        help="The path to the everest configuration file.",
         type=partial(_yaml_config, parser=arg_parser),
     )
-    arg_parser.add_argument("output_config", help="The path to the new everest file")
+    arg_parser.add_argument(
+        "output_config", help="The path to the new everest configuration file."
+    )
     arg_parser.add_argument(
         "-b",
         "--batch",
         type=int,
-        help="Batch id from which to retrieve control values",
+        help="ID of the batch providing the new control values.",
         required=True,
     )
     return arg_parser
@@ -119,11 +137,9 @@ def config_branch_entry(args: list[str] | None = None) -> None:
             conf_controls=yml_config["controls"], opt_controls=opt_controls
         )
 
-        yaml = YAML()
-        yaml.indent(mapping=2, sequence=4, offset=2)
-        yaml.preserve_quotes = True
-        with open(options.output_config, "w", encoding="utf-8") as f:
-            yaml.dump(yml_config, f)
+        EverestConfig.write_dict_to_file(
+            yml_config, Path(options.output_config), safe_and_pure=False
+        )
         print(f"New config file {options.output_config} created.")
 
 

everest/bin/everconfigdump_script.py

@@ -3,8 +3,6 @@
 import argparse
 import sys
 
-from ruamel.yaml import YAML
-
 from everest.config import EverestConfig
 
 
@@ -18,7 +16,7 @@ def _build_args_parser() -> argparse.ArgumentParser:
         usage="""everest show <config_file>""",
     )
     arg_parser.add_argument(
-        "config_file", help="The path to the everest configuration file"
+        "config_file", help="The path to the everest configuration file."
     )
     return arg_parser
 
@@ -26,13 +24,7 @@ def _build_args_parser() -> argparse.ArgumentParser:
 def config_dump_entry(args: list[str] | None = None) -> None:
     parser = _build_args_parser()
     options = parser.parse_args(args)
-
-    config = EverestConfig.load_file(options.config_file)
-
-    yaml = YAML(typ="safe", pure=True)
-    yaml.indent = 2
-    yaml.default_flow_style = False
-    yaml.dump(config.to_dict(), sys.stdout)
+    EverestConfig.load_file(options.config_file).write_to_file(sys.stdout)
 
 
 if __name__ == "__main__":

everest/bin/everest_script.py

@@ -3,21 +3,21 @@ import argparse
 import asyncio
 import json
 import logging
-import logging.config
-import os
 import signal
 import socket
 import threading
 from functools import partial
 from pathlib import Path
+from textwrap import dedent
+
+import anyio
 
 from _ert.threading import ErtThread
 from ert.config import QueueSystem
-from ert.services import StorageService
+from ert.services import ErtServer
+from ert.storage.local_experiment import ExperimentState
 from everest.config import EverestConfig, ServerConfig
 from everest.detached import (
-    ExperimentState,
-    everserver_status,
     start_experiment,
     start_server,
     wait_for_server,
@@ -30,6 +30,8 @@ from everest.util import (
 )
 
 from .utils import (
+    ArgParseFormatter,
+    get_experiment_status,
     handle_keyboard_interrupt,
     run_detached_monitor,
     run_empty_detached_monitor,
@@ -103,16 +105,23 @@ def _build_args_parser() -> argparse.ArgumentParser:
     """Build arg parser"""
 
     arg_parser = argparse.ArgumentParser(
-        description=(
-            "Everest console runner, start an "
-            "optimization case based on a given config file"
+        description=dedent(
+            """
+            Start an optimization run.
+
+            Closing the console or interrupting the `everest run` process does
+            not terminate the optimization. To continue monitoring the running
+            optimization, use `everest monitor config_file.yml`. To stop a
+            running optimization, use `everest kill config_file.yml`.
+            """
         ),
+        formatter_class=ArgParseFormatter,
         usage="everest run <config_file> [arguments]",
     )
     arg_parser.add_argument(
         "config",
         type=partial(EverestConfig.load_file_with_argparser, parser=arg_parser),
-        help="The path to the everest configuration file",
+        help="The path to the everest configuration file.",
     )
     arg_parser.add_argument(
         "--new-run",
@@ -126,14 +135,16 @@ def _build_args_parser() -> argparse.ArgumentParser:
         help="Spawn a GUI monitoring simulation statuses.",
     )
     arg_parser.add_argument(
-        "--debug", action="store_true", help="Display debug information in the terminal"
+        "--debug",
+        action="store_true",
+        help="Display debug information in the terminal.",
     )
     arg_parser.add_argument(
         "--show-all-jobs",
         action="store_true",
         help=(
             "DEPRECATED: This option no longer has an effect, "
-            "and will be removed in a future version"
+            "and will be removed in a future version."
         ),
     )
     arg_parser.add_argument(
@@ -158,7 +169,7 @@ async def run_everest(options: argparse.Namespace) -> None:
     )
 
     try:
-        StorageService.session(
+        ErtServer.session(
             Path(ServerConfig.get_session_dir(options.config.output_dir)), timeout=1
         )
         server_running = True
@@ -183,18 +194,27 @@ async def run_everest(options: argparse.Namespace) -> None:
         job_name = fm_job.split()[0]
         logger.info(f"Everest forward model contains job {job_name}")
 
-    if os.path.exists(options.config.simulation_dir) and any(
-        os.listdir(options.config.simulation_dir)
-    ):
+    async def directory_is_nonempty(path: Path) -> bool:
+        try:
+            async for _ in anyio.Path(path).iterdir():
+                return True
+        except OSError:  # Raised if the directory is empty
+            return False
+        else:
+            return False
+
+    if await anyio.Path(
+        options.config.simulation_dir
+    ).exists() and await directory_is_nonempty(options.config.simulation_dir):
         warn_user_that_runpath_is_nonempty()
     if not options.skip_prompt:
         show_scaled_controls_warning()
 
     try:
-        output_dir = options.config.output_dir
-        config_file = options.config.config_file
-        save_config_path = os.path.join(output_dir, config_file)
-        options.config.dump(save_config_path)
+        output_dir = Path(options.config.output_dir)
+        options.config.write_to_file(
+            output_dir / options.config.config_file, drop_config_path=True
+        )
     except (OSError, LookupError) as e:
         logger.error(f"Failed to save optimization config: {e}")
 
@@ -213,7 +233,7 @@ async def run_everest(options: argparse.Namespace) -> None:
 
     print("Waiting for server ...")
     logger.debug("Waiting for response from everserver")
-    client = StorageService.session(
+    client = ErtServer.session(
         Path(ServerConfig.get_session_dir(options.config.output_dir))
     )
     wait_for_server(client, timeout=600)
@@ -253,19 +273,19 @@ async def run_everest(options: argparse.Namespace) -> None:
             )
         )
 
-    logger.info("Everest experiment finished")
-
-    everserver_status_path = ServerConfig.get_everserver_status_path(
-        options.config.output_dir
-    )
-
-    server_state = everserver_status(everserver_status_path)
-    server_state_info = server_state["message"]
-    if server_state["status"] == ExperimentState.failed:
-        raise SystemExit(f"Everest run failed with: {server_state_info}")
-    if server_state_info is not None:
-        logger.info(f"Everest run finished with: {server_state_info}")
-        print(server_state_info)
+    msg: str = ""
+    experiment_status = get_experiment_status(options.config.storage_dir)
+    if experiment_status and experiment_status.status == ExperimentState.failed:
+        msg = f"Everest run failed with: {experiment_status.message or 'Unknown error'}"
+        logger.error(msg)
+        raise SystemExit(msg)
+    if experiment_status:
+        msg = (
+            "Everest run finished with: "
+            f"{experiment_status.message or 'Experiment completed successfully'}"
+        )
+        logger.info(msg)
+        print(msg)
 
 
 if __name__ == "__main__":