diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a1915c0..e30b64cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -Contributors are welcome! To contribute please use the following steps. +Contributors are welcome! To contribute, please follow these steps. 1. Fork the **EasyFEA** Repository on GitHub via “Fork” on https://github.com/matnoel/EasyFEA. @@ -42,4 +42,4 @@ Contributors are welcome! To contribute please use the following steps. b. ```git rebase main```, this may generate rebase/merge-conflicts you should resolve now. If you get lost, you can always use ```git rebase --abort``` to abort the rebase attempt. - c. after a rebase of a branch with commits which was already pushed to a remote, you have to force-push: ```git push --force``` \ No newline at end of file + c. after a rebase of a branch with commits which was already pushed to a remote, you have to force-push: ```git push --force``` diff --git a/README.md b/README.md index 361f7664..5c038725 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ ## 🧭 Overview -**EasyFEA** is a user-friendly Python library that simplifies finite element analysis. It is flexible and supports different types of simulations without requiring users to handle complex PDE formulations. You will find below the finite element analysis that you can conduct using EasyFEA: +**EasyFEA** is a user‑friendly Python library that simplifies finite element analysis by abstracting complex PDE formulations. It is flexible and supports a range of linear and nonlinear simulations with minimal setup. You will find below the finite element analysis that you can conduct using EasyFEA: 1. [Linear elastic simulations](https://easyfea.readthedocs.io/en/stable/examples/LinearizedElasticity/index.html): `static`, `dynamic`, `contact`, `homogenization` and `mesh optimization`. 2. [Hyperelastic simulations](https://easyfea.readthedocs.io/en/stable/examples/Hyperelasticity/index.html): `static` and `dynamic` in the ``Lagrangian`` framework.. @@ -26,7 +26,7 @@ 📸 Explore the interactive **[gallery](https://easyfea.readthedocs.io/en/stable/gallery/index.html)** to visualize simulation results. -For each simulation, users create a **mesh** and a **model**. Once the simulation has been set up, defining the boundary conditions, solving the problem and visualizing the results are straightforward. +For each simulation, users create a **mesh** and a **model**. Once the simulation has been set up, defining the boundary conditions, solving the problem, and visualizing the results are straightforward. Numerous examples of mesh creation are available in the [Meshes](https://easyfea.readthedocs.io/en/stable/examples/Meshes/index.html) gallery. @@ -173,4 +173,4 @@ Bibtex: **EasyFEA** is an emerging project with a strong commitment to growth and improvement. Your input and ideas are invaluable to me. I welcome your comments and advice with open arms, encouraging a culture of respect and kindness in our collaborative journey towards improvement. -To learn more about contributing to EasyFEA, please consult the [Contributing Guide](https://github.com/matnoel/EasyFEA/blob/main/CONTRIBUTING.md). \ No newline at end of file +To learn more about contributing to EasyFEA, please consult the [Contributing Guide](https://github.com/matnoel/EasyFEA/blob/main/CONTRIBUTING.md). diff --git a/examples/README.rst b/examples/README.rst index 3eeafa87..ef93fd4f 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -4,3 +4,27 @@ Examples ======== Contains example scripts demonstrating the use of numerous simulations that can be run with EasyFEA. + +New to EasyFEA? Start with `HelloWorld.py` which is a simple 2D cantilever beam example. + +.. list-table:: + :header-rows: 1 + + * - Folder + - Description + * - Beam + - Euler-Bernoulli beam simulations (1D/2D) + * - LinearizedElasticity + - Linear elastostatic and elastodynamic simulations + * - Hyperelasticity + - Nonlinear hyperelastic static simulations + * - Thermal + - Heat transfer / thermal simulations + * - PhaseField + - Quasi-static brittle fracture via phase-field damage models + * - WeakForms + - Static, transient, and dynamic simulations (linear & nonlinear) + * - MachineLearning + - ML-assisted simulations and parameter identification + * - Meshes + - Mesh creation examples (2D and 3D geometries)