update doc

.github/workflows/build_sphinx_doc.yml

@@ -0,0 +1,41 @@
+name: sphinx build doc html
+
+on:
+  push:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build-html:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          pwd
+          ls -al
+          python -m pip install --upgrade pip
+          pip install -r doc/requirements.txt
+      - name: Build HTML
+        run: |
+          pwd
+          ls -al
+          cd doc
+          make clean
+          make html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

README.md

@@ -12,13 +12,11 @@ User manual and other supporting document are in `doc`.
 
 ## Build from source
 
-Need to request ma28 library first and make some changes according to Tutorial_GEBT_Installation.pdf.
-
-To compile the code, you need to use the makefile in the bin directory.
 
 
 ### Linux
 
+To compile the code, you need to use the makefile in the bin directory.
 
 
 ### Windows

doc/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6ec1fc9d115777c00ebd2a7879b79b80
+tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/build/html/_sources/bib.rst.txt

@@ -0,0 +1,6 @@
+References
+==========
+
+.. [hodges1990mixed] D. H. Hodges. A mixed variational formulation based on exact intrinsic equations for dynamics of moving beams. International Journal of Solids and Structures, 26(11):1253-1273, 1990.
+
+

doc/build/html/_sources/convention.rst.txt

@@ -0,0 +1,5 @@
+Conventions
+===========
+
+
+

doc/build/html/_sources/index.rst.txt

@@ -0,0 +1,56 @@
+.. gebt documentation master file, created by
+   sphinx-quickstart on Wed Nov 20 10:02:56 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+GEBT
+==================
+
+GEBT (Geometrically Exact Beam Theory) is a code implementing the mixed variational formulation of the geometrically exact intrinsic beam theory developed by Prof. Hodges of Georgia Institute of Technology [hodges1990mixed]_, which captures all the geometrical nonlinearities obtainable by a beam model.
+It is a companion code of VABS, a general-purpose cross-sectional analysis tool, to enable efficient yet high-fidelity analysis of slender structures, whether they are made of composite materials or not.
+
+For effective design space explorations, we need to simplify the original nonlinear three-dimensional (3D) analysis of slender structures into a two-dimensional (2D) cross-sectional analysis and a one-dimensional (1D) nonlinear beam analysis.
+This has been achieved using VABS along with GEBT.
+VABS takes a finite element mesh of the cross-section including all the details of geometry and material as inputs to calculate the sectional properties including structural and inertial properties.
+These properties are needed for GEBT to predict the global behavior of the slender structure.
+The 3D pointwise displacement/strain/stress distribution within the structure can also be recovered by providing outputs from GEBT into VABS.
+
+
+
+
+Features
+--------
+
+GEBT adopts the mixed variational formulation of the geometrically exact beam theory of Prof. Hodges.
+It uses the lowest possible shape functions and the element matrices are calculated exactly without numerical integration.
+Since it is a mixed variational formulation, the complete set of variables can be directly calculated.
+For example, for static analysis, we can obtain three displacements, three rotations, three forces, and three moments.
+GEBT can treat an arbitrary assembly of beams made of arbitrary material and oriented arbitrarily in the 3D space.
+GEBT uses dynamic link libraries (DLLs) to encapsulate the analysis capability so that it has true plug-n-play capability which is convenient for integration into other environments.
+Now GEBT can be used both as a standalone application and a callable library.
+A GEBT manual for developers can be requested separately.
+
+
+
+
+Functionalities
+---------------
+
+The most recent version of GEBT, GEBT 4.0, has the following functionalities:
+
+1. Static, both linear and nonlinear, analysis of beam assemblies with straight and/or initially curved/twisted members under prescribed concentrated or distributed forces/moments or displacements/rotations.
+2. Static, both linear and nonlinear, analysis of beam assemblies with straight members and/or initially curved/twisted with linearly varying sectional properties.
+3. Static, nonlinear, analysis of beam assemblies with straight and/or initially curved/twisted members under prescribed distributed or concentrated follower forces/moments.
+4. Steady state of the dynamic response of beam assemblies with straight and/or initially curved/twisted members under prescribed distributed or concentrated dead or follower forces/moments.
+5. Transient dynamic response of beam assemblies with straight and/or initially curved/twisted members under prescribed distributed or concentrated dead or follower forces/moments.
+6. Sensitivities for the global beam responses for all the aforementioned analysis capabilities.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   convention
+   input
+   output
+   bib

doc/build/html/_sources/input.rst.txt

@@ -0,0 +1,5 @@
+Input Guide
+===========
+
+
+

doc/build/html/_sources/output.rst.txt

@@ -0,0 +1,5 @@
+Output Guide
+============
+
+
+