Geode-solutions Explicit Models

Common errors

• ImportError: cannot import name 'RegularGrid' from 'geode_explicit.regular_grid'

  cause Incorrect or outdated import path. For `geode-explicit` v7.x, many core classes are directly exposed under the top-level `geode_explicit` module.
  fix Update your import statement to `from geode_explicit import RegularGrid` (or the respective class name).

• AttributeError: 'RegularGrid' object has no attribute 'get_cells_number'

  cause This method name (or similar) was likely used in older versions (e.g., 6.x) and has been renamed or replaced in 7.x.
  fix Consult the `geode-explicit` v7.x documentation for the correct method name. For this specific case, `grid.nb_cells()` is the correct equivalent.

• ERROR: No matching distribution found for geode-explicit

  cause The Python version in use is not supported by `geode-explicit`, or the package index cannot be reached.
  fix Verify your Python version is between 3.9 and 3.12 (inclusive). If not, switch to a supported Python version. Also check internet connectivity and PyPI availability.

• RuntimeError: OpenGeode error: Error message from underlying C++ library

  cause This is a generic error indicating an issue within the underlying Geode C++ library, often due to invalid input data, memory constraints, or unexpected geometric configurations.
  fix Examine the exact C++ error message for clues. Check your input data (e.g., bounding box coordinates, grid dimensions) for validity and consistency. Simplify the problem or provide more robust input to narrow down the cause.

Warnings

• breaking The Geode-solutions ecosystem, including `geode-explicit`, underwent significant refactoring for version 7.x. Users migrating from 6.x should expect breaking API changes, particularly in class names, constructor arguments, and method signatures.
  Fix: Refer to the official Geode-solutions documentation and release notes for version 7.x for updated API details. Update import paths, class instantiations, and method calls accordingly.
• gotcha `geode-explicit` is built on top of C++ libraries. While `pip` handles most dependencies, error messages can sometimes be low-level C++ exceptions (e.g., `std::runtime_error`) which are less descriptive than typical Python errors. Debugging may require familiarity with underlying geometric concepts.
  Fix: When encountering cryptic errors, check the input data for validity (e.g., non-degenerate geometries, correct dimensions) and refer to the Geode-solutions C++ documentation for deeper insight into specific functions.
• breaking The library has strict Python version requirements (`>=3.9, <3.13`). Attempting to install or use `geode-explicit` with unsupported Python versions will lead to installation failures or runtime errors due to pre-compiled C++ bindings.
  Fix: Ensure your Python environment meets the `requires_python` specification. Use a virtual environment manager like `conda` or `venv` to create an environment with a compatible Python version.
• gotcha `geode-explicit` relies on a large ecosystem of other `geode-*` packages (e.g., `geode-common`, `geode-model`). While `pip` manages these dependencies, ensuring all `geode-*` packages in your environment are of compatible versions is crucial. An incompatibility in one package can lead to runtime issues or crashes in `geode-explicit`.
  Fix: Always install `geode-explicit` in a clean virtual environment or ensure all `geode-*` packages are updated to their latest compatible versions using `pip install --upgrade geode-solutions` (which attempts to upgrade the entire ecosystem).

Install

• pip install geode-explicit Install latest version

Imports

• RegularGrid

  from geode_explicit import RegularGrid

• ExplicitSolid

  from geode_explicit import ExplicitSolid

• Point3D

  from geode_common import Point3D

  Common utility class from the geode_common package, a core dependency.

Quickstart

This quickstart demonstrates how to create a 3D `RegularGrid` from a bounding box, save it to a file, and then load it back. It utilizes common utility classes like `Point3D` and `BoundingBox` from `geode-common`.

import os
from geode_explicit import RegularGrid
from geode_common import Point3D, BoundingBox

# Define the bounding box for the grid
min_point = Point3D([0.0, 0.0, 0.0])
max_point = Point3D([10.0, 10.0, 10.0])
grid_bbox = BoundingBox(min_point, max_point)

# Create a 3D regular grid with 10x10x10 cells
grid_dimensions = [10, 10, 10]
grid = RegularGrid(grid_bbox, grid_dimensions)

print(f"Created a RegularGrid with {grid.nb_cells()} cells.")
print(f"Grid origin: {grid.grid_origin()}")
print(f"Grid cell size: {grid.cell_size()}")

# Save the grid to a file
output_filename = "my_regular_grid.grd"
grid.save_regular_grid(output_filename)
print(f"Grid saved to {output_filename}")

# Load the grid from the file
loaded_grid = RegularGrid.load_regular_grid(output_filename)
print(f"Loaded a RegularGrid with {loaded_grid.nb_cells()} cells.")

# Clean up the created file
os.remove(output_filename)