Skip to content

release/v0.1.5 #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mdmaas merged 2 commits into from
May 29, 2026
Merged

release/v0.1.5 #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d21ff3c
export runtime env helpers and run_env alias
mdmaas May 29, 2026
d2357f9
refactor run_palace call
mdmaas May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 0 additions & 50 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,56 +92,6 @@ See `docs/getting-started/compatibility-policy.md` for the full policy and relea
- `vX.Y.Z` triggers main package build/publish workflow for `palace-toolkit`.
- Both workflows also support manual dispatch from GitHub Actions.

### Optional: Power-user source build (nightly/custom)

Source builds are opt-in and disabled by default.
Use this only if you need custom flags (CUDA/HIP/MAGMA/etc.) or nightly Palace.

```bash
git clone https://github.com/EpsilonForge/PalaceToolkit.git
cd PalaceToolkit
python -m venv .venv
source .venv/bin/activate

PALACETOOLKIT_BUILD_PALACE=1 \
PALACETOOLKIT_CLONE_NIGHTLY=1 \
PALACETOOLKIT_PALACE_WITH_CUDA=0 \
PALACETOOLKIT_PALACE_WITH_HIP=0 \
PALACETOOLKIT_PALACE_WITH_MAGMA=0 \
pip install -e .

# Optional: point runtime to your just-built Palace binary or SIF
# python -c "from palacetoolkit.simulation import set_palace_path; set_palace_path('/path/to/palace')"
```

Source builds are cached at:

`~/.cache/palacetoolkit/palace/<source-key>-<platform>-<options-hash>/build/bin/palace`

On subsequent installs, the cached build is reused automatically. Useful controls:

```bash
# Force rebuild even when cache exists
PALACETOOLKIT_FORCE_PALACE_REBUILD=1 pip install -e .

# Use a local Palace source tree instead of cloning nightly
PALACETOOLKIT_PALACE_SOURCE=/path/to/palace PALACETOOLKIT_BUILD_PALACE=1 pip install -e .

# Override parallel build jobs
PALACETOOLKIT_PALACE_JOBS=8 pip install -e .

# Extra custom CMake args
PALACETOOLKIT_PALACE_EXTRA_CMAKE_ARGS="-DCMAKE_BUILD_TYPE=Release" pip install -e .
```

The core install pulls `gmsh`, `numpy`, `meshio`, `pyvista`,
`enlighten`, and `pint`. The optional dependency groups are:

| Group | Extra packages |
|-------|---------------|
| `plot` | `pandas`, `matplotlib` |
| `docs` | `mkdocs`, `mkdocs-material`, `pyvista[jupyter]`, `nbconvert`, `ipykernel`, `papermill`, `nb-clean`, `pre-commit` |

## Quick start

See `docs/examples/` notebooks for worked examples covering waveguides,
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/coax_to_waveguide.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,7 +721,7 @@
],
"metadata": {
"kernelspec": {
"display_name": ".venv (3.12.3)",
"display_name": ".venv",
"language": "python",
"name": "python3"
},
Expand Down
60 changes: 30 additions & 30 deletions docs/examples/horn_antenna.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,34 +326,34 @@
"name": "stdout",
"output_type": "stream",
"text": [
"Info : [ 0%] Difference \r",
"Info : [ 10%] Difference \r",
"Info : [ 20%] Difference \r",
"Info : [ 30%] Difference \r",
"Info : [ 40%] Difference \r",
"Info : [ 50%] Difference \r",
"Info : [ 60%] Difference \r",
"Info : [ 70%] Difference - Building splits of containers \r",
"Info : [ 80%] Difference - Splitting faces \r",
" \r",
"Info : [ 0%] Difference \r",
"Info : [ 10%] Difference \r",
"Info : [ 20%] Difference \r",
"Info : [ 30%] Difference \r",
"Info : [ 40%] Difference \r",
"Info : [ 50%] Difference \r",
"Info : [ 60%] Difference \r",
"Info : [ 70%] Difference - Building splits of containers \r",
"Info : [ 80%] Difference - Splitting faces \r",
"Info : [ 0%] Fragments \r",
"Info : [ 10%] Fragments \r",
"Info : [ 20%] Fragments \r",
"Info : [ 30%] Fragments \r",
"Info : [ 40%] Fragments \r",
"Info : [ 50%] Fragments \r",
"Info : [ 60%] Fragments \r",
"Info : [ 70%] Fragments \r",
"Info : [ 80%] Fragments - Splitting faces \r",
"Info : [ 0%] Difference \r\n",
"Info : [ 10%] Difference \r\n",
"Info : [ 20%] Difference \r\n",
"Info : [ 30%] Difference \r\n",
"Info : [ 40%] Difference \r\n",
"Info : [ 50%] Difference \r\n",
"Info : [ 60%] Difference \r\n",
"Info : [ 70%] Difference - Building splits of containers \r\n",
"Info : [ 80%] Difference - Splitting faces \r\n",
" \r\n",
"Info : [ 0%] Difference \r\n",
"Info : [ 10%] Difference \r\n",
"Info : [ 20%] Difference \r\n",
"Info : [ 30%] Difference \r\n",
"Info : [ 40%] Difference \r\n",
"Info : [ 50%] Difference \r\n",
"Info : [ 60%] Difference \r\n",
"Info : [ 70%] Difference - Building splits of containers \r\n",
"Info : [ 80%] Difference - Splitting faces \r\n",
"Info : [ 0%] Fragments \r\n",
"Info : [ 10%] Fragments \r\n",
"Info : [ 20%] Fragments \r\n",
"Info : [ 30%] Fragments \r\n",
"Info : [ 40%] Fragments \r\n",
"Info : [ 50%] Fragments \r\n",
"Info : [ 60%] Fragments \r\n",
"Info : [ 70%] Fragments \r\n",
"Info : [ 80%] Fragments - Splitting faces \r\n",
" Physical group 'outer_boundary' (dim=3): pg=1, tags=[2]\n",
" Physical group 'waveguide' (dim=2): pg=2, tags=[9, 10, 7, 8]\n",
" Physical group 'flare' (dim=2): pg=3, tags=[3, 4, 5, 6]\n",
Expand Down Expand Up @@ -634,7 +634,7 @@
],
"metadata": {
"kernelspec": {
"display_name": ".venv (3.12.3)",
"display_name": ".venv",
"language": "python",
"name": "python3"
},
Expand Down Expand Up @@ -665,4 +665,4 @@
},
"nbformat": 4,
"nbformat_minor": 5
}
}
Loading
Loading