Make decorator that executes an agenda in parallel (#1117)

Now you can do

```python3
@pyarts.in_parallel(ws=ws)
def create_agenda_parallel(ws: pyarts.Workspace):
  ws.abs_speciesSet(species=["H2O", "CO2"])
  ws.atm_pointInit()
```

The two methods are executed in parallel. Note that this will come with
overhead, and the example above is clearly faster to run serial.

Author: riclarsson

.gitignore

@@ -41,3 +41,4 @@ heaptrack.*.gz
 qdrant_storage/
 .roo/
 tests/core/sensor/sensor_count.xml
+tests/core/xml/test.xml

python/src/pyarts3/__init__.py.in

@@ -2,7 +2,7 @@
 """This module contains functions to interact with ARTS."""
 
 from pyarts3 import arts  # noqa
-from pyarts3.workspace import Workspace, arts_agenda  # noqa
+from pyarts3.workspace import Workspace, arts_agenda, in_parallel  # noqa
 from pyarts3.workspace.callback import callback_operator  # noqa
 
 def __getattr__(attr):

python/src/pyarts3/workspace/__init__.py

@@ -6,6 +6,6 @@
 
 """
 
-from pyarts3.workspace.workspace import Workspace, arts_agenda # noqa
+from pyarts3.workspace.workspace import Workspace, arts_agenda, in_parallel # noqa
 from pyarts3.workspace.callback import callback_operator # noqa
 from pyarts3.workspace.compatible import compat # noqa

python/src/pyarts3/workspace/workspace.py

@@ -522,3 +522,21 @@ def parser(fn):
         return parser
     else:
         return _arts_agenda(func, ws, fix)
+
+
+def in_parallel(func=None, *, ws=None):
+    """
+    Parses the decorated function into an Agenda and executes it immediately
+    using the provided workspace.
+    """
+    def execute(fn):
+        if ws is None:
+            raise ValueError("Workspace 'ws' must be provided to in_parallel")
+        agenda = _arts_agenda(fn, None, False)
+        agenda._set_name(getsource(fn))
+        agenda.par_execute(ws)
+        return agenda
+
+    if func is None:
+        return execute
+    return execute(func)

src/core/xml/xml_io.h

@@ -68,7 +68,7 @@ try {
   return xml_file;
 } catch (const std::exception& e) {
   throw std::runtime_error(
-      std::format("Error reading file {}:\n{}", filename, e.what()));
+      std::format("Cannot read file: \"{}\":\n{}", filename, e.what()));
 }
 
 //! Extends data from XML file
@@ -91,10 +91,7 @@ try {
   return xml_file;
 } catch (const std::exception& e) {
   throw std::runtime_error(
-      std::format("Error extending file {} containing {}:\n{}",
-                  filename,
-                  xml_io_stream_name_v<T>,
-                  e.what()));
+      std::format("Cannot extend file: \"{}\" containing {}:\n{}", filename, xml_io_stream_name_v<T>, e.what()));
 }
 
 //! Appends data from XML file
@@ -117,7 +114,7 @@ try {
   return xml_file;
 } catch (const std::exception& e) {
   throw std::runtime_error(
-      std::format("Error appending file {} containing {}:\n{}",
+      std::format("Cannot append file: \"{}\" containing {}:\n{}",
                   filename,
                   xml_io_stream_name_v<T>,
                   e.what()));

src/core/xml/xml_io_base.cpp

@@ -207,7 +207,7 @@ void XMLTag::get_attribute_value(const std::string_view& aname, Index& value) {
   strstr >> value;
   if (strstr.fail()) {
     xml_parse_error(std::format(
-        "Error while parsing value of {0} from <{1}>", aname, name));
+        "Cannot parse value of {0} from <{1}>", aname, name));
   }
 }
 
@@ -220,7 +220,7 @@ void XMLTag::get_attribute_value(const std::string_view& aname, Size& value) {
   strstr >> value;
   if (strstr.fail()) {
     xml_parse_error(std::format(
-        "Error while parsing value of {0} from <{1}>", aname, name));
+        "Cannot parse value of {0} from <{1}>", aname, name));
   }
 }
 
@@ -234,7 +234,7 @@ void XMLTag::get_attribute_value(const std::string_view& aname,
   strstr >> double_imanip() >> value;
   if (strstr.fail()) {
     xml_parse_error(std::format(
-        "Error while parsing value of {0} from <{1}>", aname, name));
+        "Cannot parse value of {0} from <{1}>", aname, name));
   }
 }
 

src/core/xml/xml_io_base.h

@@ -227,8 +227,8 @@ void xml_read_from_file_base(const String& filename, T& type) try {
   xml_io_stream<T>::read(buffer, type, xsh);
   xml_read_footer_from_stream(buffer);
 } catch (const std::runtime_error& e) {
-  throw std::runtime_error(
-      std::format("Error reading file {}:\n{}", filename, e.what()));
+  throw std::runtime_error(std::format(
+      "Cannot read file with full filename: \"{}\":\n{}", filename, e.what()));
 }
 
 //! Extends data from XML file
@@ -249,8 +249,8 @@ void xml_extend_from_file_base(const String& filename, T& type) try {
   xml_io_stream<T>::extend(buffer, type, xsh);
   xml_read_footer_from_stream(buffer);
 } catch (const std::runtime_error& e) {
-  throw std::runtime_error(
-      std::format("Error reading file {}:\n{}", filename, e.what()));
+  throw std::runtime_error(std::format(
+      "Cannot extend file with full filename: \"{}\":\n{}", filename, e.what()));
 }
 
 //! Appends data from XML file
@@ -271,8 +271,8 @@ void xml_append_from_file_base(const String& filename, T& type) try {
   xml_io_stream<T>::append(buffer, type, xsh);
   xml_read_footer_from_stream(buffer);
 } catch (const std::runtime_error& e) {
-  throw std::runtime_error(
-      std::format("Error reading file {}:\n{}", filename, e.what()));
+  throw std::runtime_error(std::format(
+      "Cannot append file with full filename: \"{}\":\n{}", filename, e.what()));
 }
 
 //! Write data to XML file
@@ -321,9 +321,8 @@ void xml_write_to_file_base(const String& filename,
 
     xml_write_footer_to_stream(*ofs);
   } catch (const std::runtime_error& e) {
-    std::ostringstream os;
-    os << "Error writing file: " << filename << '\n' << e.what();
-    throw std::runtime_error(os.str());
+    throw std::runtime_error(std::format(
+        "Cannot write file with full filename: \"{}\":\n{}", filename, e.what()));
   }
 }
 
@@ -332,7 +331,7 @@ void xml_read_from_stream(std::istream& i, T& v, bifstream* b = nullptr) try {
   xml_io_stream<T>::read(i, v, b);
 } catch (const std::exception& e) {
   throw std::runtime_error(std::format(
-      "Error streaming {}:\n{}", xml_io_stream<T>::type_name, e.what()));
+      "Cannot stream {}:\n{}", xml_io_stream<T>::type_name, e.what()));
 }
 
 template <arts_xml_ioable T>

src/core/xml/xml_io_stream_aggregate.h

@@ -263,6 +263,6 @@ struct xml_io_stream<T> {
     tag.check_end_name(type_name);
   } catch (const std::exception& e) {
     throw std::runtime_error(
-        std::format("Error reading {}:\n{}", type_name, e.what()));
+        std::format("Cannot read {}:\n{}", type_name, e.what()));
   }
 };

src/core/xml/xml_io_stream_array.h

@@ -81,7 +81,7 @@ struct xml_io_stream<Array<T>> {
     tag.check_end_name(type_name);
   } catch (const std::exception& e) {
     throw std::runtime_error(std::format(
-        "Error extending {}<{}>:\n{}", type_name, inner::type_name, e.what()));
+        "Cannot extend {}<{}>:\n{}", type_name, inner::type_name, e.what()));
   }
 
   static void append(std::istream& is,
@@ -92,7 +92,7 @@ struct xml_io_stream<Array<T>> {
     n.emplace_back(std::move(x));
   } catch (const std::exception& e) {
     throw std::runtime_error(std::format(
-        "Error appending {}<{}>:\n{}", type_name, inner::type_name, e.what()));
+        "Cannot append {}<{}>:\n{}", type_name, inner::type_name, e.what()));
   }
 
   static void read(std::istream& is,
@@ -102,7 +102,7 @@ struct xml_io_stream<Array<T>> {
     extend(is, n, pbifs);
   } catch (const std::exception& e) {
     throw std::runtime_error(std::format(
-        "Error reading {}<{}>:\n{}", type_name, inner::type_name, e.what()));
+        "Cannot read {}<{}>:\n{}", type_name, inner::type_name, e.what()));
   }
 };
 

src/core/xml/xml_io_stream_enum_options.h

@@ -51,6 +51,6 @@ struct xml_io_stream<T> {
     tag.check_end_name(type_name);
   } catch (const std::exception& e) {
     throw std::runtime_error(
-        std::format("Error reading enum {}:\n{}", type_name, e.what()));
+        std::format("Cannot read enum {}:\n{}", type_name, e.what()));
   }
 };