Skip to content

Update readme #45

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
jmartfrut merged 3 commits into from
Nov 3, 2025
Merged

Update readme #45

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d53311
Updates repository links in README
jmartfrut Nov 3, 2025
059bd2a
Updates README for improved readability
jmartfrut Nov 3, 2025
1f708d7
Updates project description in README
jmartfrut Nov 3, 2025
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
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,18 @@ src="https://github.com/jmartfrut/HyperFEM/blob/main/docs/imgs/logo.png?raw=true

# Multiphysics Simulation of Multifunctional Soft Materials

<div align="justify" style="margin-left: 40px; margin-right: 40px;">

**HyperFEM** is a library within the [Gridap](https://github.com/gridap/Gridap.jl) ecosystem designed for the simulation of multiphysics problems involving multifunctional hyperelastic materials. The ultimate goal of HyperFEM is to provide a **high-level, expressive, and rapid prototyping tool** that accelerates the modeling stages of **Thermo–Electro–Magneto–Mechanical** multiphysics problems. To this end, it includes a comprehensive library of **analytically derived constitutive models** formulated through tensor algebra. In addition, HyperFEM provides abstractions for **monolithic and staggered solution schemes**, extending Gridap’s capabilities in the context of **nonlinear solid mechanics**.

</div>



## Installation
Open the Julia REPL, type `]` to enter package mode, and install as follows
```julia
pkg> add https://github.com/jmartfrut/HyperFEM
pkg> add https://github.com/MultiSimOLab/HyperFEM
```

## Usage
Expand Down Expand Up @@ -127,7 +132,7 @@ x = solve!(comp_model; stepping=(nsteps=5, maxbisec=5), post=post_model)
<p align="center">
&nbsp; &nbsp; &nbsp; &nbsp;
<img alt="Dark"
src="https://github.com/MultiSimOLab/HyperFEM/blob/HGO/docs/imgs/sims_.png?raw=true" width="110%">
src="https://github.com/MultiSimOLab/HyperFEM/blob/main/docs/imgs/sims_.png?raw=true" width="110%">
</p>


Expand Down