From 684e772ef3ed03b4ae8d2659970cc794163160fd Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 18 Jun 2026 07:59:57 +0000
Subject: [PATCH 1/2] Initial plan


From ca5860bd5320321f714f926e5b261f0dc66f4117 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 18 Jun 2026 08:02:29 +0000
Subject: [PATCH 2/2] docs: add top-level code layout overview

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 4f82f69..e9d5fe9 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,13 @@
 
 For modeling and simulation, you need to install `FEniCSx`, `CSDL` and the Python-based backend of `CSDL` - [python_csdl_backend](https://github.com/LSDOlab/python_csdl_backend); for optimization, you will also need [ModOpt](https://github.com/LSDOlab/modopt) on top of them for the black-box optimizers. 
 
+## Code layout
+
+- `femo/fea/`: core finite-element wrappers, PDE solves, and derivative utilities built around FEniCSx.
+- `femo/csdl_opt/`: CSDL-facing models that expose states, outputs, and optimization couplings.
+- `examples/`: end-to-end problem setups showing how to assemble and run the framework.
+- `docs/`: Sphinx documentation sources.
+
 ## Installation
 
 It's recommended to use conda for installing the module and its dependencies.