foamlib 0.6.5__tar.gz → 0.6.7__tar.gz

{foamlib-0.6.5 → foamlib-0.6.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.6.5
+Version: 0.6.7
 Summary: A Python interface for interacting with OpenFOAM
 Author-email: "Gabriel S. Gerlero" <ggerlero@cimec.unl.edu.ar>
 Project-URL: Homepage, https://github.com/gerlero/foamlib
@@ -30,6 +30,7 @@ Requires-Dist: aioshutil<2,>=1
 Requires-Dist: pyparsing<4,>=3
 Requires-Dist: typing-extensions<5,>=4; python_version < "3.11"
 Provides-Extra: numpy
+Requires-Dist: numpy<3,>=1.25.0; python_version >= "3.10" and extra == "numpy"
 Requires-Dist: numpy<3,>=1; extra == "numpy"
 Provides-Extra: lint
 Requires-Dist: ruff; extra == "lint"
@@ -43,7 +44,7 @@ Requires-Dist: foamlib[test]; extra == "typing"
 Requires-Dist: mypy<2,>=1; extra == "typing"
 Provides-Extra: docs
 Requires-Dist: foamlib[numpy]; extra == "docs"
-Requires-Dist: sphinx<9,>=7; extra == "docs"
+Requires-Dist: sphinx<9,>=5; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: foamlib[numpy]; extra == "dev"
@@ -59,7 +60,9 @@ Requires-Dist: foamlib[docs]; extra == "dev"
 [![Codecov](https://codecov.io/gh/gerlero/foamlib/branch/main/graph/badge.svg)](https://codecov.io/gh/gerlero/foamlib)
 [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![PyPI](https://img.shields.io/pypi/v/foamlib)](https://pypi.org/project/foamlib/)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/foamlib)](https://anaconda.org/conda-forge/foamlib)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/foamlib)](https://pypi.org/project/foamlib/)
 ![OpenFOAM](https://img.shields.io/badge/openfoam-.com%20|%20.org-informational)
 [![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
@@ -68,19 +71,26 @@ Requires-Dist: foamlib[docs]; extra == "dev"
 
 It offers the following classes:
 
-* [`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile) (and [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFieldFile)): read-write access to OpenFOAM configuration and field files as if they were Python `dict`s, using `foamlib`'s own parser. Supports both ASCII and binary field formats.
+* [`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile) (and [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFieldFile)): read-write access to OpenFOAM configuration and field files as if they were Python `dict`s, using `foamlib`'s own parser. Supports ASCII and binary field formats (with or without compression).
 * [`FoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.FoamCase): a class for configuring, running, and accessing the results of OpenFOAM cases.
 * [`AsyncFoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.AsyncFoamCase): variant of `FoamCase` with asynchronous methods for running multiple cases at once.
+* [`AsyncSlurmFoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.AsyncSlurmFoamCase): subclass of `AsyncFoamCase` used for running cases on a Slurm cluster.
 
 ## Get started
 
 ### Install
 
-Install with [pip](https://pypi.org/project/pip/):
+* With [pip](https://pypi.org/project/pip/):
 
-```bash
-pip install foamlib
-```
+    ```bash
+    pip install foamlib
+    ```
+
+* With [conda](https://docs.conda.io/en/latest/):
+
+    ```bash
+    conda install -c conda-forge foamlib
+    ```
 
 ### Clone a case
 
@@ -164,6 +174,7 @@ from foamlib import AsyncFoamCase
 from scipy.optimize import differential_evolution
 
 base = AsyncFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
+# Replace with `AsyncSlurmFoamCase` if on a cluster and you want cases to be run as Slurm jobs
 
 async def cost(x):
     async with base.clone() as clone:

{foamlib-0.6.5 → foamlib-0.6.7}/README.md

@@ -5,7 +5,9 @@
 [![Codecov](https://codecov.io/gh/gerlero/foamlib/branch/main/graph/badge.svg)](https://codecov.io/gh/gerlero/foamlib)
 [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![PyPI](https://img.shields.io/pypi/v/foamlib)](https://pypi.org/project/foamlib/)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/foamlib)](https://anaconda.org/conda-forge/foamlib)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/foamlib)](https://pypi.org/project/foamlib/)
 ![OpenFOAM](https://img.shields.io/badge/openfoam-.com%20|%20.org-informational)
 [![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
@@ -14,19 +16,26 @@
 
 It offers the following classes:
 
-* [`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile) (and [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFieldFile)): read-write access to OpenFOAM configuration and field files as if they were Python `dict`s, using `foamlib`'s own parser. Supports both ASCII and binary field formats.
+* [`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile) (and [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFieldFile)): read-write access to OpenFOAM configuration and field files as if they were Python `dict`s, using `foamlib`'s own parser. Supports ASCII and binary field formats (with or without compression).
 * [`FoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.FoamCase): a class for configuring, running, and accessing the results of OpenFOAM cases.
 * [`AsyncFoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.AsyncFoamCase): variant of `FoamCase` with asynchronous methods for running multiple cases at once.
+* [`AsyncSlurmFoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.AsyncSlurmFoamCase): subclass of `AsyncFoamCase` used for running cases on a Slurm cluster.
 
 ## Get started
 
 ### Install
 
-Install with [pip](https://pypi.org/project/pip/):
+* With [pip](https://pypi.org/project/pip/):
 
-```bash
-pip install foamlib
-```
+    ```bash
+    pip install foamlib
+    ```
+
+* With [conda](https://docs.conda.io/en/latest/):
+
+    ```bash
+    conda install -c conda-forge foamlib
+    ```
 
 ### Clone a case
 
@@ -110,6 +119,7 @@ from foamlib import AsyncFoamCase
 from scipy.optimize import differential_evolution
 
 base = AsyncFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
+# Replace with `AsyncSlurmFoamCase` if on a cluster and you want cases to be run as Slurm jobs
 
 async def cost(x):
     async with base.clone() as clone:

{foamlib-0.6.5 → foamlib-0.6.7}/foamlib/__init__.py

@@ -1,6 +1,6 @@
 """A Python interface for interacting with OpenFOAM."""
 
-__version__ = "0.6.5"
+__version__ = "0.6.7"
 
 from ._cases import (
     AsyncFoamCase,

{foamlib-0.6.5 → foamlib-0.6.7}/foamlib/_cases/_async.py

@@ -101,7 +101,7 @@ class AsyncFoamCase(FoamCaseRunBase):
     async def _rmtree(
         path: Union["os.PathLike[str]", str], ignore_errors: bool = False
     ) -> None:
-        await aioshutil.rmtree(path, ignore_errors=ignore_errors)  # type: ignore [call-arg]
+        await aioshutil.rmtree(path, ignore_errors=ignore_errors)
 
     @staticmethod
     async def _copytree(
@@ -188,7 +188,7 @@ class AsyncFoamCase(FoamCaseRunBase):
     @asynccontextmanager
     async def copy(
         self, dst: Optional[Union["os.PathLike[str]", str]] = None
-    ) -> "AsyncGenerator[Self]":
+    ) -> AsyncGenerator[Self, None]:
         """
         Make a copy of this case.
 
@@ -209,7 +209,7 @@ class AsyncFoamCase(FoamCaseRunBase):
     @asynccontextmanager
     async def clone(
         self, dst: Optional[Union["os.PathLike[str]", str]] = None
-    ) -> "AsyncGenerator[Self]":
+    ) -> AsyncGenerator[Self, None]:
         """
         Clone this case (make a clean copy).
 

{foamlib-0.6.5 → foamlib-0.6.7}/foamlib/_cases/_subprocess.py

@@ -2,6 +2,7 @@ import asyncio
 import os
 import subprocess
 import sys
+from io import BytesIO
 from typing import IO, Optional, Union
 
 if sys.version_info >= (3, 9):
@@ -48,22 +49,26 @@ def run_sync(
         shell=isinstance(cmd, str),
     )
 
-    error = b""
-
     if stderr == STDOUT:
         stderr = stdout
     if stderr not in (PIPE, DEVNULL):
+        stderr_copy = BytesIO()
+
         assert not isinstance(stderr, int)
         if stderr is None:
             stderr = sys.stderr.buffer
 
         assert proc.stderr is not None
         for line in proc.stderr:
-            error += line
             stderr.write(line)
+            stderr_copy.write(line)
+
+        output, _ = proc.communicate()
+        assert not _
+        error = stderr_copy.getvalue()
+    else:
+        output, error = proc.communicate()
 
-    output, _ = proc.communicate()
-    assert not _
     assert proc.returncode is not None
 
     if check and proc.returncode != 0:
@@ -108,22 +113,26 @@ async def run_async(
             stderr=PIPE,
         )
 
-    error = b""
-
     if stderr == STDOUT:
         stderr = stdout
     if stderr not in (PIPE, DEVNULL):
+        stderr_copy = BytesIO()
+
         assert not isinstance(stderr, int)
         if stderr is None:
             stderr = sys.stderr.buffer
 
         assert proc.stderr is not None
         async for line in proc.stderr:
-            error += line
             stderr.write(line)
+            stderr_copy.write(line)
+
+        output, _ = await proc.communicate()
+        assert not _
+        error = stderr_copy.getvalue()
+    else:
+        output, error = await proc.communicate()
 
-    output, _ = await proc.communicate()
-    assert not _
     assert proc.returncode is not None
 
     if check and proc.returncode != 0:

{foamlib-0.6.5 → foamlib-0.6.7}/foamlib/_cases/_sync.py

@@ -1,7 +1,6 @@
 import os
 import shutil
 import sys
-from pathlib import Path
 from types import TracebackType
 from typing import Any, Callable, Optional, Type, Union, overload
 
@@ -49,9 +48,6 @@ class FoamCase(FoamCaseRunBase):
 
             return calls.value
 
-    def __init__(self, path: Union["os.PathLike[str]", str] = Path()):
-        super().__init__(path)
-
     @staticmethod
     def _run(
         cmd: Union[Sequence[Union[str, "os.PathLike[str]"]], str],

{foamlib-0.6.5 → foamlib-0.6.7}/foamlib/_files/_files.py

@@ -86,7 +86,7 @@ class FoamFile(
 
         def as_dict(self) -> FoamFileBase._Dict:
             """Return a nested dict representation of the dictionary."""
-            ret = self._file.as_dict()
+            ret = self._file.as_dict(include_header=True)
 
             for k in self._keywords:
                 assert isinstance(ret, dict)
@@ -294,15 +294,10 @@ class FoamFile(
 
     def _iter(self, keywords: Tuple[str, ...] = ()) -> Iterator[Optional[str]]:
         _, parsed = self._read()
-
-        yield from (
-            k[-1] if k else None
-            for k in parsed
-            if k != ("FoamFile",) and k[:-1] == keywords
-        )
+        yield from (k[-1] if k else None for k in parsed if k[:-1] == keywords)
 
     def __iter__(self) -> Iterator[Optional[str]]:
-        return self._iter()
+        yield from (k for k in self._iter() if k != "FoamFile")
 
     def __contains__(self, keywords: object) -> bool:
         if not keywords:
@@ -328,11 +323,16 @@ class FoamFile(
     def __fspath__(self) -> str:
         return str(self.path)
 
-    def as_dict(self) -> FoamFileBase._File:
-        """Return a nested dict representation of the file."""
+    def as_dict(self, *, include_header: bool = False) -> FoamFileBase._File:
+        """
+        Return a nested dict representation of the file.
+
+        :param include_header: Whether to include the "FoamFile" header in the output.
+        """
         _, parsed = self._read()
         d = parsed.as_dict()
-        del d["FoamFile"]
+        if not include_header:
+            d.pop("FoamFile", None)
         return d
 
 

{foamlib-0.6.5 → foamlib-0.6.7}/foamlib/_files/_parsing.py

@@ -95,18 +95,35 @@ def _unpack_binary_field(
     return [all]
 
 
+_IDENTCHARS = identchars + "$"
+_IDENTBODYCHARS = (
+    printables.replace(";", "")
+    .replace("{", "")
+    .replace("}", "")
+    .replace("[", "")
+    .replace("]", "")
+)
+
 _SWITCH = (
-    Keyword("yes") | Keyword("true") | Keyword("on") | Keyword("y") | Keyword("t")
+    Keyword("yes", _IDENTBODYCHARS)
+    | Keyword("true", _IDENTBODYCHARS)
+    | Keyword("on", _IDENTBODYCHARS)
+    | Keyword("y", _IDENTBODYCHARS)
+    | Keyword("t", _IDENTBODYCHARS)
 ).set_parse_action(lambda: True) | (
-    Keyword("no") | Keyword("false") | Keyword("off") | Keyword("n") | Keyword("f")
+    Keyword("no", _IDENTBODYCHARS)
+    | Keyword("false", _IDENTBODYCHARS)
+    | Keyword("off", _IDENTBODYCHARS)
+    | Keyword("n", _IDENTBODYCHARS)
+    | Keyword("f", _IDENTBODYCHARS)
 ).set_parse_action(lambda: False)
 _DIMENSIONS = (
     Literal("[").suppress() + common.number[0, 7] + Literal("]").suppress()
 ).set_parse_action(lambda tks: FoamFileBase.DimensionSet(*tks))
 _TENSOR = _list_of(common.number) | common.number
 _IDENTIFIER = Combine(
-    Word(identchars + "$", printables, exclude_chars="[{(;)}]")
-    + Opt(Literal("(") + Word(printables, exclude_chars="[{(;)}]") + Literal(")"))
+    Word(_IDENTCHARS, _IDENTBODYCHARS, exclude_chars="()")
+    + Opt(Literal("(") + Word(_IDENTBODYCHARS, exclude_chars="()") + Literal(")"))
 )
 _DIMENSIONED = (Opt(_IDENTIFIER) + _DIMENSIONS + _TENSOR).set_parse_action(
     lambda tks: FoamFileBase.Dimensioned(*reversed(tks.as_list()))

{foamlib-0.6.5 → foamlib-0.6.7}/foamlib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.6.5
+Version: 0.6.7
 Summary: A Python interface for interacting with OpenFOAM
 Author-email: "Gabriel S. Gerlero" <ggerlero@cimec.unl.edu.ar>
 Project-URL: Homepage, https://github.com/gerlero/foamlib
@@ -30,6 +30,7 @@ Requires-Dist: aioshutil<2,>=1
 Requires-Dist: pyparsing<4,>=3
 Requires-Dist: typing-extensions<5,>=4; python_version < "3.11"
 Provides-Extra: numpy
+Requires-Dist: numpy<3,>=1.25.0; python_version >= "3.10" and extra == "numpy"
 Requires-Dist: numpy<3,>=1; extra == "numpy"
 Provides-Extra: lint
 Requires-Dist: ruff; extra == "lint"
@@ -43,7 +44,7 @@ Requires-Dist: foamlib[test]; extra == "typing"
 Requires-Dist: mypy<2,>=1; extra == "typing"
 Provides-Extra: docs
 Requires-Dist: foamlib[numpy]; extra == "docs"
-Requires-Dist: sphinx<9,>=7; extra == "docs"
+Requires-Dist: sphinx<9,>=5; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: foamlib[numpy]; extra == "dev"
@@ -59,7 +60,9 @@ Requires-Dist: foamlib[docs]; extra == "dev"
 [![Codecov](https://codecov.io/gh/gerlero/foamlib/branch/main/graph/badge.svg)](https://codecov.io/gh/gerlero/foamlib)
 [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![PyPI](https://img.shields.io/pypi/v/foamlib)](https://pypi.org/project/foamlib/)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/foamlib)](https://anaconda.org/conda-forge/foamlib)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/foamlib)](https://pypi.org/project/foamlib/)
 ![OpenFOAM](https://img.shields.io/badge/openfoam-.com%20|%20.org-informational)
 [![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
@@ -68,19 +71,26 @@ Requires-Dist: foamlib[docs]; extra == "dev"
 
 It offers the following classes:
 
-* [`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile) (and [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFieldFile)): read-write access to OpenFOAM configuration and field files as if they were Python `dict`s, using `foamlib`'s own parser. Supports both ASCII and binary field formats.
+* [`FoamFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFile) (and [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/files.html#foamlib.FoamFieldFile)): read-write access to OpenFOAM configuration and field files as if they were Python `dict`s, using `foamlib`'s own parser. Supports ASCII and binary field formats (with or without compression).
 * [`FoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.FoamCase): a class for configuring, running, and accessing the results of OpenFOAM cases.
 * [`AsyncFoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.AsyncFoamCase): variant of `FoamCase` with asynchronous methods for running multiple cases at once.
+* [`AsyncSlurmFoamCase`](https://foamlib.readthedocs.io/en/stable/cases.html#foamlib.AsyncSlurmFoamCase): subclass of `AsyncFoamCase` used for running cases on a Slurm cluster.
 
 ## Get started
 
 ### Install
 
-Install with [pip](https://pypi.org/project/pip/):
+* With [pip](https://pypi.org/project/pip/):
 
-```bash
-pip install foamlib
-```
+    ```bash
+    pip install foamlib
+    ```
+
+* With [conda](https://docs.conda.io/en/latest/):
+
+    ```bash
+    conda install -c conda-forge foamlib
+    ```
 
 ### Clone a case
 
@@ -164,6 +174,7 @@ from foamlib import AsyncFoamCase
 from scipy.optimize import differential_evolution
 
 base = AsyncFoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/simpleFoam/pitzDaily")
+# Replace with `AsyncSlurmFoamCase` if on a cluster and you want cases to be run as Slurm jobs
 
 async def cost(x):
     async with base.clone() as clone:

{foamlib-0.6.5 → foamlib-0.6.7}/foamlib.egg-info/requires.txt

@@ -13,7 +13,7 @@ foamlib[docs]
 
 [docs]
 foamlib[numpy]
-sphinx<9,>=7
+sphinx<9,>=5
 sphinx_rtd_theme
 
 [lint]
@@ -22,6 +22,9 @@ ruff
 [numpy]
 numpy<3,>=1
 
+[numpy:python_version >= "3.10"]
+numpy<3,>=1.25.0
+
 [test]
 foamlib[numpy]
 pytest<9,>=7

{foamlib-0.6.5 → foamlib-0.6.7}/pyproject.toml

@@ -37,7 +37,10 @@ dependencies = [
 dynamic = ["version"]
 
 [project.optional-dependencies]
-numpy = ["numpy>=1,<3"]
+numpy = [
+    "numpy>=1.25.0,<3; python_version>='3.10'",
+    "numpy>=1,<3"
+]
 lint = ["ruff"]
 test = [
     "foamlib[numpy]",
@@ -51,7 +54,7 @@ typing = [
 ]
 docs = [
     "foamlib[numpy]",
-    "sphinx>=7,<9",
+    "sphinx>=5,<9",
     "sphinx_rtd_theme",
 ]
 dev = [