PyPI - foamlib - Versions diffs - 0.6.6__tar.gz → 0.6.8__tar.gz - Mend

foamlib 0.6.6tar.gz → 0.6.8tar.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.

Files changed (27) hide show

{foamlib-0.6.6 → foamlib-0.6.8}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.6.6
+Version: 0.6.8
 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"
@@ -52,38 +53,50 @@ Requires-Dist: foamlib[test]; extra == "dev"
 Requires-Dist: foamlib[typing]; extra == "dev"
 Requires-Dist: foamlib[docs]; extra == "dev"
-[<img alt="foamlib" src="https://github.com/gerlero/foamlib/raw/main/logo.png" height="50">](https://github.com/gerlero/foamlib)
+[<img alt="foamlib" src="https://github.com/gerlero/foamlib/raw/main/logo.png" height="65">](https://github.com/gerlero/foamlib)
 [![Documentation](https://img.shields.io/readthedocs/foamlib)](https://foamlib.readthedocs.io/)
 [![CI](https://github.com/gerlero/foamlib/actions/workflows/ci.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/ci.yml)
 [![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)
+[![Publish](https://github.com/gerlero/foamlib/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/pypi-publish.yml)
 [![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](https://github.com/gerlero/foamlib/actions/workflows/docker.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/docker.yml)
 [![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
+## 👋 Basics
 **foamlib** provides a simple, modern and ergonomic Python interface for interacting with [OpenFOAM](https://www.openfoam.com).
-It offers the following classes:
+It offers the following Python 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 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
+## ☑️ Get started
-### Install
+### 📦 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
+### 🐑 Clone a case
 ```python
 import os
@@ -95,13 +108,13 @@ pitz_tutorial = FoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/si
 my_pitz = pitz_tutorial.clone("myPitz")
 ```
-### Run the case
+### 🏃 Run the case
 ```python
 my_pitz.run()
 ```
-### Access the results
+### 🔎 Access the results
 ```python
 latest_time = my_pitz[-1]
@@ -113,19 +126,19 @@ print(p.internal_field)
 print(U.internal_field)
 ```
-### Clean the case
+### 🧹 Clean the case
 ```python
 my_pitz.clean()
 ```
-### Edit the `controlDict` file
+### ⚙️ Edit the `controlDict` file
 ```python
 my_pitz.control_dict["writeInterval"] = 10
 ```
-### Make multiple file reads and writes in a single go
+### 📝 Make multiple file reads and writes in a single go
 ```python
 with my_pitz.fv_schemes as f:
@@ -133,7 +146,7 @@ with my_pitz.fv_schemes as f:
     f["snGradSchemes"]["default"] = "uncorrected"
 ```
-### Run a case asynchronously
+### ⏳ Run a case asynchronously
 ```python
 import asyncio
@@ -146,7 +159,7 @@ async def run_case():
 asyncio.run(run_case())
 ```
-### Parse a field using the [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/#foamlib.FoamFieldFile) class directly
+### 🔢 Parse a field using the [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/#foamlib.FoamFieldFile) class directly
 ```python
 from foamlib import FoamFieldFile
@@ -156,7 +169,7 @@ U = FoamFieldFile(Path(my_pitz) / "0/U")
 print(U.internal_field)
 ```
-### Run an optimization loop in parallel
+### 🔁 Run an optimization loop in parallel
 ```python
 import os
@@ -176,7 +189,7 @@ async def cost(x):
 result = differential_evolution(cost, bounds=[(-1, 1)], workers=AsyncFoamCase.map, polish=False)
 ```
-### Use it to create a `run` (or `clean`) script
+### 📄 Use it to create a `run` (or `clean`) script
 ```python
 #!/usr/bin/env python3
@@ -188,6 +201,6 @@ case = FoamCase(Path(__file__).parent)
 case.run()
 ```
-## Documentation
+## 📘 Documentation
 For more information, check out the [documentation](https://foamlib.readthedocs.io/).

{foamlib-0.6.6 → foamlib-0.6.8}/README.md RENAMED Viewed

@@ -1,35 +1,47 @@
-[<img alt="foamlib" src="https://github.com/gerlero/foamlib/raw/main/logo.png" height="50">](https://github.com/gerlero/foamlib)
+[<img alt="foamlib" src="https://github.com/gerlero/foamlib/raw/main/logo.png" height="65">](https://github.com/gerlero/foamlib)
 [![Documentation](https://img.shields.io/readthedocs/foamlib)](https://foamlib.readthedocs.io/)
 [![CI](https://github.com/gerlero/foamlib/actions/workflows/ci.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/ci.yml)
 [![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)
+[![Publish](https://github.com/gerlero/foamlib/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/pypi-publish.yml)
 [![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](https://github.com/gerlero/foamlib/actions/workflows/docker.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/docker.yml)
 [![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
+## 👋 Basics
 **foamlib** provides a simple, modern and ergonomic Python interface for interacting with [OpenFOAM](https://www.openfoam.com).
-It offers the following classes:
+It offers the following Python 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 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
+## ☑️ Get started
-### Install
+### 📦 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
+### 🐑 Clone a case
 ```python
 import os
@@ -41,13 +53,13 @@ pitz_tutorial = FoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/si
 my_pitz = pitz_tutorial.clone("myPitz")
 ```
-### Run the case
+### 🏃 Run the case
 ```python
 my_pitz.run()
 ```
-### Access the results
+### 🔎 Access the results
 ```python
 latest_time = my_pitz[-1]
@@ -59,19 +71,19 @@ print(p.internal_field)
 print(U.internal_field)
 ```
-### Clean the case
+### 🧹 Clean the case
 ```python
 my_pitz.clean()
 ```
-### Edit the `controlDict` file
+### ⚙️ Edit the `controlDict` file
 ```python
 my_pitz.control_dict["writeInterval"] = 10
 ```
-### Make multiple file reads and writes in a single go
+### 📝 Make multiple file reads and writes in a single go
 ```python
 with my_pitz.fv_schemes as f:
@@ -79,7 +91,7 @@ with my_pitz.fv_schemes as f:
     f["snGradSchemes"]["default"] = "uncorrected"
 ```
-### Run a case asynchronously
+### ⏳ Run a case asynchronously
 ```python
 import asyncio
@@ -92,7 +104,7 @@ async def run_case():
 asyncio.run(run_case())
 ```
-### Parse a field using the [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/#foamlib.FoamFieldFile) class directly
+### 🔢 Parse a field using the [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/#foamlib.FoamFieldFile) class directly
 ```python
 from foamlib import FoamFieldFile
@@ -102,7 +114,7 @@ U = FoamFieldFile(Path(my_pitz) / "0/U")
 print(U.internal_field)
 ```
-### Run an optimization loop in parallel
+### 🔁 Run an optimization loop in parallel
 ```python
 import os
@@ -122,7 +134,7 @@ async def cost(x):
 result = differential_evolution(cost, bounds=[(-1, 1)], workers=AsyncFoamCase.map, polish=False)
 ```
-### Use it to create a `run` (or `clean`) script
+### 📄 Use it to create a `run` (or `clean`) script
 ```python
 #!/usr/bin/env python3
@@ -134,6 +146,6 @@ case = FoamCase(Path(__file__).parent)
 case.run()
 ```
-## Documentation
+## 📘 Documentation
 For more information, check out the [documentation](https://foamlib.readthedocs.io/).

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib/__init__.py RENAMED Viewed

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

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib/_cases/_async.py RENAMED Viewed

@@ -1,9 +1,8 @@
 import asyncio
 import multiprocessing
-import os
 import sys
 from contextlib import asynccontextmanager
-from typing import Any, Callable, Optional, TypeVar, Union, overload
+from typing import TYPE_CHECKING, Any, Callable, Optional, TypeVar, Union, overload
 if sys.version_info >= (3, 9):
     from collections.abc import (
@@ -29,6 +28,9 @@ from ._run import FoamCaseRunBase
 from ._subprocess import run_async
 from ._util import ValuedGenerator, awaitableasynccontextmanager
+if TYPE_CHECKING:
+    import os
 X = TypeVar("X")
 Y = TypeVar("Y")
@@ -101,7 +103,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(
@@ -138,8 +140,11 @@ class AsyncFoamCase(FoamCaseRunBase):
         ret = super().__getitem__(index)
         if isinstance(ret, FoamCaseBase.TimeDirectory):
             return AsyncFoamCase.TimeDirectory(ret)
-        else:
-            return [AsyncFoamCase.TimeDirectory(r) for r in ret]
+        return [AsyncFoamCase.TimeDirectory(r) for r in ret]
+    async def _prepare(self, *, check: bool = True, log: bool = True) -> None:
+        for coro in self._prepare_calls(check=check, log=log):
+            await coro
     async def run(
         self,
@@ -188,7 +193,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 +214,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.6 → foamlib-0.6.8}/foamlib/_cases/_base.py RENAMED Viewed

@@ -1,8 +1,8 @@
-import os
 import shutil
 import sys
 from pathlib import Path
 from typing import (
+    TYPE_CHECKING,
     Optional,
     Union,
     overload,
@@ -23,6 +23,9 @@ else:
 from .._files import FoamFieldFile, FoamFile
+if TYPE_CHECKING:
+    import os
 class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
     def __init__(self, path: Union["os.PathLike[str]", str] = Path()):
@@ -57,18 +60,16 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
         def __getitem__(self, key: str) -> FoamFieldFile:
             if (self.path / f"{key}.gz").is_file() and not (self.path / key).is_file():
                 return FoamFieldFile(self.path / f"{key}.gz")
-            else:
-                return FoamFieldFile(self.path / key)
+            return FoamFieldFile(self.path / key)
         def __contains__(self, obj: object) -> bool:
             if isinstance(obj, FoamFieldFile):
                 return obj.path.parent == self.path and obj.path.is_file()
-            elif isinstance(obj, str):
+            if isinstance(obj, str):
                 return (self.path / obj).is_file() or (
                     self.path / f"{obj}.gz"
                 ).is_file()
-            else:
-                return False
+            return False
         def __iter__(self) -> Iterator[FoamFieldFile]:
             for p in self.path.iterdir():
@@ -124,7 +125,7 @@ class FoamCaseBase(Sequence["FoamCaseBase.TimeDirectory"]):
     ) -> Union["FoamCaseBase.TimeDirectory", Sequence["FoamCaseBase.TimeDirectory"]]:
         if isinstance(index, str):
             return FoamCaseBase.TimeDirectory(self.path / index)
-        elif isinstance(index, float):
+        if isinstance(index, float):
             for time in self._times:
                 if time.time == index:
                     return time

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib/_cases/_run.py RENAMED Viewed

@@ -115,6 +115,12 @@ class FoamCaseRunBase(FoamCaseBase):
     def clone(self, dst: Optional[Union["os.PathLike[str]", str]] = None) -> Any:
         raise NotImplementedError
+    @abstractmethod
+    def _prepare(
+        self, *, check: bool = True, log: bool = True
+    ) -> Union[None, Coroutine[None, None, None]]:
+        raise NotImplementedError
     @abstractmethod
     def run(
         self,
@@ -208,6 +214,18 @@ class FoamCaseRunBase(FoamCaseBase):
         return script
+    def __prepare_script(self) -> Optional[Path]:
+        """Return the path to the Allrun.pre script, or None if no prepare script is found."""
+        script = self.path / "Allrun.pre"
+        if not script.is_file():
+            return None
+        if sys.argv and Path(sys.argv[0]).absolute() == script.absolute():
+            return None
+        return script
     def __run_script(self, *, parallel: Optional[bool]) -> Optional[Path]:
         """Return the path to the (All)run script, or None if no run script is found."""
         run = self.path / "run"
@@ -256,8 +274,7 @@ class FoamCaseRunBase(FoamCaseBase):
                 env["DYLD_LIBRARY_PATH"] = env["FOAM_LD_LIBRARY_PATH"]
             return env
-        else:
-            return None
+        return None
     @contextmanager
     def __output(
@@ -267,10 +284,7 @@ class FoamCaseRunBase(FoamCaseBase):
             if isinstance(cmd, str):
                 name = shlex.split(cmd)[0]
             else:
-                if isinstance(cmd[0], os.PathLike):
-                    name = Path(cmd[0]).name
-                else:
-                    name = cmd[0]
+                name = Path(cmd[0]).name if isinstance(cmd[0], os.PathLike) else cmd[0]
             with (self.path / f"log.{name}").open("ab") as stdout:
                 yield stdout, STDOUT
@@ -341,6 +355,15 @@ class FoamCaseRunBase(FoamCaseBase):
     ) -> Generator[Any, None, None]:
         yield self.run(["reconstructPar"], cpus=0, check=check, log=log)
+    def _prepare_calls(self, *, check: bool, log: bool) -> Generator[Any, None, None]:
+        script_path = self.__prepare_script()
+        if script_path is not None:
+            yield self.run([script_path], log=log, check=check)
+        elif (self.path / "system" / "blockMeshDict").is_file():
+            yield self.block_mesh(check=check, log=log)
     def _run_calls(
         self,
         cmd: Optional[Union[Sequence[Union[str, "os.PathLike[str]"]], str]] = None,
@@ -406,12 +429,11 @@ class FoamCaseRunBase(FoamCaseBase):
                 )
             else:
+                yield self._prepare(check=check, log=log)
                 if not self and (self.path / "0.orig").is_dir():
                     yield self.restore_0_dir()
-                if (self.path / "system" / "blockMeshDict").is_file():
-                    yield self.block_mesh(check=check)
                 if parallel is None:
                     parallel = (
                         (cpus is not None and cpus > 1)

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib/_cases/_slurm.py RENAMED Viewed

@@ -1,7 +1,6 @@
-import os
 import shutil
 import sys
-from typing import Any, Optional, Union
+from typing import TYPE_CHECKING, Any, Optional, Union
 if sys.version_info >= (3, 9):
     from collections.abc import Sequence
@@ -11,6 +10,9 @@ else:
 from ._async import AsyncFoamCase
 from ._subprocess import run_async
+if TYPE_CHECKING:
+    import os
 class AsyncSlurmFoamCase(AsyncFoamCase):
     """An asynchronous OpenFOAM case that launches jobs on a Slurm cluster."""

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib/_cases/_subprocess.py RENAMED Viewed

@@ -1,9 +1,11 @@
 import asyncio
-import os
 import subprocess
 import sys
 from io import BytesIO
-from typing import IO, Optional, Union
+from typing import IO, TYPE_CHECKING, Optional, Union
+if TYPE_CHECKING:
+    import os
 if sys.version_info >= (3, 9):
     from collections.abc import Mapping, Sequence
@@ -18,7 +20,7 @@ class CalledProcessError(subprocess.CalledProcessError):
         if self.stderr:
             if isinstance(self.stderr, bytes):
                 return super().__str__() + "\n" + self.stderr.decode()
-            elif isinstance(self.stderr, str):
+            if isinstance(self.stderr, str):
                 return super().__str__() + "\n" + self.stderr
         return super().__str__()

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib/_cases/_sync.py RENAMED Viewed

@@ -1,8 +1,7 @@
-import os
 import shutil
 import sys
 from types import TracebackType
-from typing import Any, Callable, Optional, Type, Union, overload
+from typing import TYPE_CHECKING, Any, Callable, Optional, Type, Union, overload
 if sys.version_info >= (3, 9):
     from collections.abc import Collection, Sequence
@@ -20,6 +19,9 @@ from ._run import FoamCaseRunBase
 from ._subprocess import run_sync
 from ._util import ValuedGenerator
+if TYPE_CHECKING:
+    import os
 class FoamCase(FoamCaseRunBase):
     """
@@ -44,8 +46,6 @@ class FoamCase(FoamCaseRunBase):
             for _ in calls:
                 pass
-            print(calls.value)
             return calls.value
     @staticmethod
@@ -89,8 +89,7 @@ class FoamCase(FoamCaseRunBase):
         ret = super().__getitem__(index)
         if isinstance(ret, FoamCaseBase.TimeDirectory):
             return FoamCase.TimeDirectory(ret)
-        else:
-            return [FoamCase.TimeDirectory(r) for r in ret]
+        return [FoamCase.TimeDirectory(r) for r in ret]
     def __enter__(self) -> Self:
         return self
@@ -112,6 +111,10 @@ class FoamCase(FoamCaseRunBase):
         for _ in self._clean_calls(check=check):
             pass
+    def _prepare(self, *, check: bool = True, log: bool = True) -> None:
+        for _ in self._prepare_calls(check=check, log=log):
+            pass
     def run(
         self,
         cmd: Optional[Union[Sequence[Union[str, "os.PathLike[str]"]], str]] = None,

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib/_files/_base.py RENAMED Viewed

@@ -1,17 +1,15 @@
 import sys
 from dataclasses import dataclass
-from typing import Dict, NamedTuple, Optional, Tuple, Union
+from typing import TYPE_CHECKING, Dict, NamedTuple, Optional, Tuple, Union
+if TYPE_CHECKING:
+    import numpy as np
 if sys.version_info >= (3, 9):
     from collections.abc import Mapping, Sequence
 else:
     from typing import Mapping, Sequence
-try:
-    import numpy as np
-except ModuleNotFoundError:
-    pass
 class FoamFileBase:
     class DimensionSet(NamedTuple):

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib/_files/_files.py RENAMED Viewed

@@ -1,5 +1,5 @@
 import sys
-from typing import Any, Optional, Tuple, Union, cast
+from typing import TYPE_CHECKING, Any, Optional, Tuple, Union, cast
 if sys.version_info >= (3, 8):
     from typing import Literal
@@ -16,10 +16,8 @@ from ._io import FoamFileIO
 from ._serialization import Kind, dumpb
 from ._util import is_sequence
-try:
+if TYPE_CHECKING:
     import numpy as np
-except ModuleNotFoundError:
-    pass
 class FoamFile(
@@ -86,7 +84,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)
@@ -172,8 +170,7 @@ class FoamFile(
         if value is ...:
             return FoamFile.SubDict(self, keywords)
-        else:
-            return value
+        return value
     def __setitem__(
         self, keywords: Optional[Union[str, Tuple[str, ...]]], data: "FoamFile._SetData"
@@ -294,15 +291,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 +320,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.6 → foamlib-0.6.8}/foamlib/_files/_io.py RENAMED Viewed

@@ -1,10 +1,10 @@
 import gzip
-import os
 import sys
 from copy import deepcopy
 from pathlib import Path
 from types import TracebackType
 from typing import (
+    TYPE_CHECKING,
     Optional,
     Tuple,
     Type,
@@ -18,6 +18,9 @@ else:
 from ._parsing import Parsed
+if TYPE_CHECKING:
+    import os
 class FoamFileIO:
     def __init__(self, path: Union["os.PathLike[str]", str]) -> None:
@@ -63,8 +66,7 @@ class FoamFileIO:
         if self.__contents is None:
             if missing_ok:
                 return b"", Parsed(b"")
-            else:
-                raise FileNotFoundError(self.path)
+            raise FileNotFoundError(self.path)
         if self.__parsed is None:
             parsed = Parsed(self.__contents)

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib/_files/_parsing.py RENAMED Viewed

@@ -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.6 → foamlib-0.6.8}/foamlib/_files/_serialization.py RENAMED Viewed

@@ -35,7 +35,7 @@ def dumpb(
     if numpy and isinstance(data, np.ndarray):
         return dumpb(data.tolist(), kind=kind)
-    elif isinstance(data, Mapping):
+    if isinstance(data, Mapping):
         entries = []
         for k, v in data.items():
             b = dumpb(v, kind=kind)
@@ -48,12 +48,12 @@ def dumpb(
         return b" ".join(entries)
-    elif isinstance(data, FoamFileBase.DimensionSet) or (
+    if isinstance(data, FoamFileBase.DimensionSet) or (
         kind == Kind.DIMENSIONS and is_sequence(data) and len(data) == 7
     ):
         return b"[" + b" ".join(dumpb(v) for v in data) + b"]"
-    elif (kind == Kind.FIELD or kind == Kind.BINARY_FIELD) and (
+    if (kind == Kind.FIELD or kind == Kind.BINARY_FIELD) and (
         isinstance(data, (int, float))
         or is_sequence(data)
         and data
@@ -62,7 +62,7 @@ def dumpb(
     ):
         return b"uniform " + dumpb(data, kind=Kind.SINGLE_ENTRY)
-    elif (kind == Kind.FIELD or kind == Kind.BINARY_FIELD) and is_sequence(data):
+    if (kind == Kind.FIELD or kind == Kind.BINARY_FIELD) and is_sequence(data):
         if isinstance(data[0], (int, float)):
             tensor_kind = b"scalar"
         elif len(data[0]) == 3:
@@ -88,10 +88,10 @@ def dumpb(
         return b"nonuniform List<" + tensor_kind + b"> " + dumpb(len(data)) + contents
-    elif kind != Kind.SINGLE_ENTRY and isinstance(data, tuple):
+    if kind != Kind.SINGLE_ENTRY and isinstance(data, tuple):
         return b" ".join(dumpb(v) for v in data)
-    elif isinstance(data, FoamFileBase.Dimensioned):
+    if isinstance(data, FoamFileBase.Dimensioned):
         if data.name is not None:
             return (
                 dumpb(data.name)
@@ -100,20 +100,18 @@ def dumpb(
                 + b" "
                 + dumpb(data.value, kind=Kind.SINGLE_ENTRY)
             )
-        else:
-            return (
-                dumpb(data.dimensions, kind=Kind.DIMENSIONS)
-                + b" "
-                + dumpb(data.value, kind=Kind.SINGLE_ENTRY)
-            )
+        return (
+            dumpb(data.dimensions, kind=Kind.DIMENSIONS)
+            + b" "
+            + dumpb(data.value, kind=Kind.SINGLE_ENTRY)
+        )
-    elif is_sequence(data):
+    if is_sequence(data):
         return b"(" + b" ".join(dumpb(v, kind=Kind.SINGLE_ENTRY) for v in data) + b")"
-    elif data is True:
+    if data is True:
         return b"yes"
-    elif data is False:
+    if data is False:
         return b"no"
-    else:
-        return str(data).encode("latin-1")
+    return str(data).encode("latin-1")

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib.egg-info/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: foamlib
-Version: 0.6.6
+Version: 0.6.8
 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"
@@ -52,38 +53,50 @@ Requires-Dist: foamlib[test]; extra == "dev"
 Requires-Dist: foamlib[typing]; extra == "dev"
 Requires-Dist: foamlib[docs]; extra == "dev"
-[<img alt="foamlib" src="https://github.com/gerlero/foamlib/raw/main/logo.png" height="50">](https://github.com/gerlero/foamlib)
+[<img alt="foamlib" src="https://github.com/gerlero/foamlib/raw/main/logo.png" height="65">](https://github.com/gerlero/foamlib)
 [![Documentation](https://img.shields.io/readthedocs/foamlib)](https://foamlib.readthedocs.io/)
 [![CI](https://github.com/gerlero/foamlib/actions/workflows/ci.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/ci.yml)
 [![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)
+[![Publish](https://github.com/gerlero/foamlib/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/pypi-publish.yml)
 [![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](https://github.com/gerlero/foamlib/actions/workflows/docker.yml/badge.svg)](https://github.com/gerlero/foamlib/actions/workflows/docker.yml)
 [![Docker image](https://img.shields.io/badge/docker%20image-microfluidica%2Ffoamlib-0085a0)](https://hub.docker.com/r/microfluidica/foamlib/)
+## 👋 Basics
 **foamlib** provides a simple, modern and ergonomic Python interface for interacting with [OpenFOAM](https://www.openfoam.com).
-It offers the following classes:
+It offers the following Python 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 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
+## ☑️ Get started
-### Install
+### 📦 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
+### 🐑 Clone a case
 ```python
 import os
@@ -95,13 +108,13 @@ pitz_tutorial = FoamCase(Path(os.environ["FOAM_TUTORIALS"]) / "incompressible/si
 my_pitz = pitz_tutorial.clone("myPitz")
 ```
-### Run the case
+### 🏃 Run the case
 ```python
 my_pitz.run()
 ```
-### Access the results
+### 🔎 Access the results
 ```python
 latest_time = my_pitz[-1]
@@ -113,19 +126,19 @@ print(p.internal_field)
 print(U.internal_field)
 ```
-### Clean the case
+### 🧹 Clean the case
 ```python
 my_pitz.clean()
 ```
-### Edit the `controlDict` file
+### ⚙️ Edit the `controlDict` file
 ```python
 my_pitz.control_dict["writeInterval"] = 10
 ```
-### Make multiple file reads and writes in a single go
+### 📝 Make multiple file reads and writes in a single go
 ```python
 with my_pitz.fv_schemes as f:
@@ -133,7 +146,7 @@ with my_pitz.fv_schemes as f:
     f["snGradSchemes"]["default"] = "uncorrected"
 ```
-### Run a case asynchronously
+### ⏳ Run a case asynchronously
 ```python
 import asyncio
@@ -146,7 +159,7 @@ async def run_case():
 asyncio.run(run_case())
 ```
-### Parse a field using the [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/#foamlib.FoamFieldFile) class directly
+### 🔢 Parse a field using the [`FoamFieldFile`](https://foamlib.readthedocs.io/en/stable/#foamlib.FoamFieldFile) class directly
 ```python
 from foamlib import FoamFieldFile
@@ -156,7 +169,7 @@ U = FoamFieldFile(Path(my_pitz) / "0/U")
 print(U.internal_field)
 ```
-### Run an optimization loop in parallel
+### 🔁 Run an optimization loop in parallel
 ```python
 import os
@@ -176,7 +189,7 @@ async def cost(x):
 result = differential_evolution(cost, bounds=[(-1, 1)], workers=AsyncFoamCase.map, polish=False)
 ```
-### Use it to create a `run` (or `clean`) script
+### 📄 Use it to create a `run` (or `clean`) script
 ```python
 #!/usr/bin/env python3
@@ -188,6 +201,6 @@ case = FoamCase(Path(__file__).parent)
 case.run()
 ```
-## Documentation
+## 📘 Documentation
 For more information, check out the [documentation](https://foamlib.readthedocs.io/).

{foamlib-0.6.6 → foamlib-0.6.8}/foamlib.egg-info/requires.txt RENAMED Viewed

@@ -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.6 → foamlib-0.6.8}/pyproject.toml RENAMED Viewed

@@ -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 = [
@@ -84,7 +87,36 @@ packages = [
 strict = true
 [tool.ruff.lint]
-extend-select = ["D", "I", "RUF", "UP"]
+extend-select = [
+    "ASYNC",
+    "B",
+    "C4",
+    "D",
+    "ERA",
+    "F",
+    "FLY",
+    "FURB",
+    "I",
+    "ICN",
+    "INT",
+    "NPY",
+    "PERF",
+    "PIE",
+    "PLC",
+    "PLE",
+    "PLW",
+    "PT",
+    "PTH",
+    "Q",
+    "RET",
+    "RSE",
+    "RUF",
+    "SIM",
+    "T20",
+    "TCH",
+    "UP",
+    "YTT",
+]
 [tool.ruff.lint.pydocstyle]
 convention = "pep257"