tidy3d 2.11.0.dev2__tar.gz → 2.11.2__tar.gz

tidy3d-2.11.2/AGENTS.md

@@ -0,0 +1,57 @@
+# Repository Guidelines
+
+## Project Structure & Documentation
+- See the root `README.md` → “Project Overview” for a map of directories, and consult subdirectory READMEs for local nuances; follow those layouts when adding code.
+- Keep all README files, `docs/`, and this AGENTS.md in sync whenever tooling or behavior changes.
+- Prefer extending existing utilities in `scripts/` before adding new helper modules.
+
+## Workflow & Tooling
+- Make sure your local environment is bootstrapped with `uv sync --frozen --extra dev` and `uv run pre-commit install`; once that’s done on a machine, you shouldn’t need to repeat it unless dependencies change.
+- The `dev` extra is the superset that includes **all** optional dependencies (pyvista, trimesh, gdstk, vtk, etc.) needed for testing. Always use `uv sync --frozen --extra dev` to get the full test environment. When adding a new optional dependency, add it to `dev` as well.
+- Use uv-managed commands (`uv run`, `uv sync`, `uv lock`, `uv build`) to match CI.
+- Re-run `uv run pytest` locally as part of your development loop; `pyproject.toml` already wires markers, doctests, coverage, and env vars.
+- The pre-commit hooks you enabled during onboarding run automatically; still run `uv run pre-commit run --all-files` before opening a PR or when new hooks land so your tree matches `.pre-commit-config.yaml` and the checks in `.github/workflows/public_tidy3d-python-client-tests.yml` (covers `ruff format`, `ruff check`, doc hooks).
+- When editing YAML, Python, or docs, match the surrounding indentation exactly; never re-indent or reformat lines you didn’t otherwise modify.
+
+### Do / Don't
+- **Do** run `uv run pre-commit run --all-files` before opening a PR; **don't** skip it even if individual hooks passed earlier.
+- **Do** stick to uv-managed commands (`uv run …`, `uv sync …`, `uv lock …`); **don't** install dependencies outside uv, since that drifts from CI environments.
+- **Do** reuse `scripts/` utilities; **don't** add new helper modules without checking for an existing script first.
+
+## Coding Style & Naming
+- Prefer top-level imports.
+- Favor descriptive `snake_case` functions and `PascalCase` classes tied to the physics domain.
+- Most simulation and monitor classes subclass `Tidy3dBaseModel`; reserve `pydantic.BaseModel` for lightweight helpers (see `tidy3d/updater.py`), and rely on `.updated_copy(...)` plus shared validators in `tidy3d/components/validators.py`.
+- Public APIs covered in `docs/` should use the existing Numpy-inspired block pattern rendered by our Sphinx Book Theme; lean on current API examples or the theme reference at https://sphinx-book-theme.readthedocs.io/en/stable/reference/api-numpy.html. Internal helpers may keep short docstrings but match local tone.
+- Prefer `tidy3d.log.log` and `tidy3d.exceptions` for contributor-facing messages; touch stdlib `logging` only when muting external libraries such as `pyroots`.
+- Reuse types from `tidy3d/components/types`, domain constants from `tidy3d/constants`, and runtime defaults from `tidy3d/config`.
+- For the `Medium` and `Simulation` class families, centralize `@model_validator(mode="after")` logic in `_run_after_validators()` with a short docstring, and call dependent checks in explicit order instead of relying on decorator registration.
+- For those same families, prefix validator helpers with `_` (e.g., `_check_*`, `_validate_*`) and use `call_wrapped_validator(...)` for validator factories so ordering stays explicit.
+- In post-init validation (`@model_validator(mode="after")`, `_run_after_validators()`, and helpers they call), use loc-aware validation errors whenever a failure can be tied to a concrete field or indexed item. Prefer `self._raise_validation_error_at_loc(...)` and `self._call_with_validation_loc(...)`; reserve plain `SetupError` for model-global invariants.
+
+## Testing Guidelines
+- Mirror the source tree with `test_<feature>.py`, add a short module docstring, and import `tidy3d as td`; keep single-use fixtures local but upstream broadly useful helpers into `tests/conftest.py`.
+- Lean on `tests/conftest.py` for RNG seeding, matplotlib cleanup, logger reset, and autograd helpers, and use pytest’s `tmp_path` for artifacts.
+- `uv run pytest` is the canonical entry point; the `pyproject` config already selects markers, doctests, coverage, xdist, and env vars, so reproduce CI locally before opening a PR.
+- Prefer pytest primitives (`pytest.raises`, `pytest.approx`, `@pytest.mark.parametrize`) for coverage, and add doctest snippets for new public APIs to keep docs and runtime behavior aligned.
+- Every new or changed loc-attributable post-init validation should include a regression test asserting the error `loc` via `assert_single_value_error_loc(...)` from `tests/utils.py`.
+- Mock all external/web APIs in tests (e.g., `web.run`, HTTP clients) and assert the contract instead of hitting live services; CI must stay hermetic.
+- Numerical tests require explicit maintainer confirmation. They run real simulations and are excluded by default (`-m 'not numerical'`). When approved, run selectively via `uv run pytest -m numerical path/to/test.py -k specific_case`.
+- Scope tests by path: `uv run pytest -q tests/test_web/` or `uv run pytest -q tidy3d/components/geometry/`.
+- Scope tests by keyword: `uv run pytest -q -k "feature_name or module_name"`.
+- Keep repo defaults (incl. xdist); for speed disable coverage and mute warnings: `uv run pytest -q --no-cov -W ignore tests/... --maxfail=1`.
+- Doctest a single module quickly: `uv run pytest -q --no-cov -W ignore tidy3d/components/foo.py`.
+
+## Schema Assets
+- Files under `schemas/` are generated artifacts; never edit them manually.
+- Run `uv run python scripts/regenerate_schema.py` after model/serialization changes, and commit the output alongside the code.
+- CI reruns the script and fails the PR whenever checked-in schemas drift from regenerated results.
+
+## Commit & Pull Request Guidelines
+- Follow Conventional Commits per `.commitlintrc.json`.
+- Branch names must use an allowed prefix (`chore`, `hotfix`, `daily-chore`) or include a Jira key to satisfy CI.
+- PRs should link issues, summarize behavior changes, list the `uv run …` checks you executed, and call out docs/schema updates.
+- For user-facing changes (new features, bug fixes, breaking changes), add a changelog fragment under `changelog.d/` using the pattern `XXXX.<type>.md` (for example `XXXX.added.md`) instead of editing `CHANGELOG.md` directly; the GitHub Action renames `XXXX` to the PR number after the PR opens, and CI rejects direct `CHANGELOG.md` edits on regular PR branches.
+- Release managers can use the GitHub Actions workflow `public/tidy3d/python-client-build-changelog-pr` to generate `CHANGELOG.md` from fragments and open a PR (defaults source/target to `develop`).
+
+_Reminder: update this AGENTS.md whenever workflow, tooling, or review expectations change so agents stay in sync with the repo._