update docs before deployment

README.md

@@ -3,8 +3,6 @@
 FENIAX is an aeroelastic toolbox  written and parallelized in Python, which acts as a post-processor of commercial software such as MSC Nastran. 
 Arbitrary FE models built for linear aeroelastic analysis are enhanced with geometric nonlinear effects, flight dynamics and linearized state-space solutions about nonlinear equilibrium.
 
-![XRF1](./docs/images/xrf1-model3.jpg)
-
 ## Installation
 
 - Currently the code has been tested and is developed in Linux and MacOS.

docs/documentation/getting_started.md

@@ -4,8 +4,37 @@ Welcome to the `Getting Started` guide for **FENIAX**.
 
 ## Installation
 
-To install the project, run:
+- Currently the code has been tested and is developed in Linux and MacOS.
+- A minimum installation into the current environment is possible by navigating to the main directory and
+```
+pip install .
+```
+
+- However developer mode is recommended and also installing the full set of packages which include testing and visualisation capabilities:
+
+```
+pip install -e .[all]
+```
+
+- see setup.py file for the options available. Python 3.9+ is required but 3.11+ is recommended. 
+Although it is not necessary, If conda is being used as package manager, one can make a specific environment as,
+
+```
+conda create -n feniax python=3.11
+conda activate fem4inas
+```
+
+- If pytest has been installed, check everything is OK by running the tests: 
+
+```
+pytest tests
+```
 
-```bash
-pip install my-project
+- Thus a typical installation would comprise of these 4 steps:
 ```
+conda create -n feniax.python=3.11
+conda activate fem4inas
+pip install -e .[all]
+pytest tests
+```
+

docs/documentation/index.md

@@ -1,42 +1,54 @@
 # Finite Element models 4 Intrinsic Nonlinear Aeroelastics in JAX
 
-FENIAX is an aeroelastic toolbox  written in Python using JAX, which acts as a post-processor of commercial software such as MSC Nastran. 
-Arbitrary FE models built for linear aeroelastic analysis are enhanced with geometric nonlinear effects, flight dynamics and linearized state-space solutions about nonlinear equilibrium.
+FENIAX is an aeroelastic toolbox  written in Python using JAX. It acts as a post-processor of commercial software such as MSC Nastran. 
+
+- Arbitrary FE models built for linear aeroelastic analysis are enhanced with geometric nonlinear effects, flight dynamics and linearized state-space solutions about nonlinear equilibrium.
+- Nonlinear solutions run very fast, at or close to real time.
+- Algorithmic differentiation (AD) of the response is available via JAX. The code is carefully crafted to perform all computations on tensor data structures and via algorithms available for AD, much like Machine Learning models are built.
+- The code can be run on modern hardware architectures such as GPUs.
 
 !!! warning 
-	The software is beta, and while it it is likely   not all Get in touch if you encounter problems
+	The software is in beta, and while it has been thoroughly tested, new features keep being added and it is likely features for your analysis might be missing. Get in touch if you encounter problems.
 
 
 
 ## Getting started
-
+If you just want to start running the code, navigate to the [Getting started](./getting_started.md)
 ## Examples
 The most relevant examples in the code base are shown here, these and more can be found in the folder `/examples`
 They are also part of a large test suite that is integrated into the development using CI/CD.
 
 !!! tip
-    Navigate to the code of the various examples, including the simulation input settings and postprocessing of the simulation --exactly as it was used for the articles backing the software.
+    Navigate to the code of the various examples, including the simulation input settings and postprocessing of the simulation --exactly as it was used for the articles backing the software. See [examples](./examples.md)
 
 
 ### Nonlinear structural static results
 !!! success
-    Validated with MSC Nastran nonlinear solution (sol 400)
+    - Validated with MSC Nastran nonlinear solution (sol 400)
+	- AD differentiation of the response verified against finite-differences
+
 
 [Notebook](./examples/SailPlane/sailplane_nb.md)
 
+![Sail Plane static](./img/SailPlane3D_front.png)
+
+!!! note
+    Take a liner FE model of arbitrary complexity from your favourite FE solver, and turn it into a fully geometrically nonlinear model. You just need a condensation step into the main load paths and the resulting linear stiffness and mass matrices.  
 ### Wing free dynamics
 !!! success
-    Validated with MSC Nastran nonlinear solution (sol 400)
-
+    - Validated with MSC Nastran nonlinear solution (sol 400)
+    - Runs over x100 faster than Nastran 
+    - AD differentiation of the response verified against finite-differences
+
 [Notebook](./examples/wingSP/wingSP_nb.md)
 
 
 ![Wing free dynamics](./media/wingSP_optimized.gif)
 
 
 ### Free flying structure
-
-[Bio](https://mechanics.stanford.edu/simo)
+This example first appeared in the work of Juan Carlos Simo (see [Bio](https://mechanics.stanford.edu/simo))
+, a pioneer in the field of computational structural mechanics and the 
 
 [Notebook](./examples/wingSP/wingSP_nb.md)
 
@@ -47,7 +59,8 @@ They are also part of a large test suite that is integrated into the development
 
 ### Industrial Aircraft model
 !!! success
-    Linear response validated with MSC Nastran linear aeroelastic solution (sol 146)
+    - Linear response validated with MSC Nastran linear aeroelastic solution (sol 146)
+	- Nonlinear response in our solvers takes similar times to the linear Nastran solution!! 
 
 #### Gust clamped model
 

mkdocs.yml

@@ -132,6 +132,7 @@ nav:
   - Home: index.md
   - Getting started: getting_started.md
   - Examples:
+      - Summary: ./examples.md
       # - Structural and aeroelastic response of clamped Aircraft: 
       # - Free-flying ultra flexible structure
       # - CPC_runs: examples/runs.md #../reports/CPC24/runs.md