{"id":23786,"library":"geode-background","title":"Geode-Background","description":"Geode-Background is a module from Geode-solutions for building background meshes used in mesh generation and numerical simulation. It is part of the OpenGeode ecosystem, currently at version 9.12.0, with a stable release cadence aligned with the Geode platform.","status":"active","version":"9.12.0","language":"python","source_language":"en","source_url":"https://github.com/Geode-solutions/Geode-Background","tags":["mesh","geode","background mesh","simulation","numerical"],"install":[{"cmd":"pip install geode-background","lang":"bash","label":"pip install (PyPI)"}],"dependencies":[{"reason":"Core Geode library required for all modules","package":"geode-core","optional":false},{"reason":"Common utilities used across Geode modules","package":"geode-common","optional":true}],"imports":[{"note":"Official import path as per API documentation.","symbol":"BackgroundCreator","correct":"from geode_background import BackgroundCreator"},{"note":"Official import path for background mesh objects.","symbol":"BackgroundMesh","correct":"from geode_background import BackgroundMesh"}],"quickstart":{"code":"from geode_background import BackgroundCreator\n\n# Create a simple background mesh (example)\ncreator = BackgroundCreator()\nbackground_mesh = creator.create_from_bounding_box(origin=(0.0,0.0,0.0), length=(1.0,1.0,1.0))\nprint('Background mesh created:', background_mesh.nb_vertices())","lang":"python","description":"Basic usage: import BackgroundCreator, create a background mesh from a bounding box."},"warnings":[{"fix":"Use `from geode_background import BackgroundCreator` and instantiate with `BackgroundCreator().create_*()` methods.","message":"Version 9.x introduced a new API: BackgroundCreator replaces old factory functions. Old code using `create_background_mesh` will break.","severity":"breaking","affected_versions":">=9.0.0"},{"fix":"Use `from geode_background.background_mesh import BackgroundMesh` instead.","message":"Direct import of names like `BackgroundMesh` from top-level package is deprecated; use submodule `geode_background.background_mesh`.","severity":"deprecated","affected_versions":">=8.0.0"},{"fix":"Install pre-built wheels via conda: `conda install -c geode-solutions geode-background`","message":"Geode-Background requires a C++ compiled backend; pip install may fail without proper build tools (e.g., Visual C++ on Windows, GCC on Linux).","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Install via pip: `pip install geode-background` and import as `from geode_background import ...`","cause":"Package not installed or installed under different name (e.g., 'geode-background' without underscore).","error":"ModuleNotFoundError: No module named 'geode_background'"},{"fix":"Upgrade to geode-background>=9.0.0: `pip install --upgrade geode-background`","cause":"Using an older version (<9.0.0) where BackgroundCreator does not exist.","error":"ImportError: cannot import name 'BackgroundCreator' from 'geode_background'"},{"fix":"Install geode-core and ensure compatible architecture. Use conda installation: `conda install -c geode-solutions geode-background`","cause":"C++ backend not found; often missing Geode-Core or platform-specific binaries.","error":"RuntimeError: No compute module available for this platform"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}