Skip to content

Document top-level code layout in README #2

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

Closed
Copilot wants to merge 2 commits into from
Closed

Document top-level code layout in README #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
684e772
Initial plan
Copilot Jun 18, 2026
ca5860b
docs: add top-level code layout overview
Copilot Jun 18, 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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down