add journal md to docs

ACea15 · Sep 12, 2024 · 1f025f3 · 1f025f3
1 parent 93d5dba
commit 1f025f3
Show file tree

Hide file tree

Showing 10 changed files with 2,771 additions and 12 deletions.
diff --git a/docs/documentation/examples/cpc_examples.md b/docs/documentation/examples/cpc_examples.md
diff --git a/docs/documentation/examples/cpc_runs.md b/docs/documentation/examples/cpc_runs.md
diff --git a/docs/documentation/examples/figs b/docs/documentation/examples/figs
@@ -0,0 +1 @@
+/Users/ac5015/projects/FENIAX/docs/reports/CPC24/figs
diff --git a/docs/documentation/examples/figs_ext b/docs/documentation/examples/figs_ext
@@ -0,0 +1 @@
+/Users/ac5015/projects/FENIAX/docs/reports/CPC24/figs_ext
diff --git a/docs/documentation/examples/runs.md b/docs/documentation/examples/runs.md
@@ -0,0 +1 @@
+/Users/ac5015/projects/FENIAX/docs/reports/CPC24/runs.md
diff --git a/docs/documentation/requirements.txt b/docs/documentation/requirements.txt
@@ -1,6 +1,7 @@
 # Latest versions at time of writing.
 mkdocs           # Main documentation generator.
 mkdocstrings[python]
+python-markdown-math
 mkdocs-material  # Theme
 pymdown-extensions  # Markdown extensions e.g. to handle LaTeX.
 mkdocstrings    # Autogenerate documentation from docstrings.

diff --git a/docs/reports/CPC24/runs.org b/docs/reports/CPC24/runs.org
@@ -79,7 +79,7 @@ Finally, automatic differentiation on both static and dynamic problems is valida
   (setq export_blocks  "results")  
 #+end_src
 
-* Load modules :noexport: 
+* Load modules 
 :PROPERTIES:
 :header-args: :mkdirp yes  :session (print pythonShell) :noweb yes  :eval (print Veval_blocks) :exports (print export_blocks) :comments both
 :END:
@@ -133,7 +133,7 @@ Finally, automatic differentiation on both static and dynamic problems is valida
 
 #+end_src
 
-* Run models :noexport:  
+* Run models 
 :PROPERTIES:
 :header-args: :mkdirp yes  :session (print pythonShell) :noweb yes :tangle ./results/run.py :eval (print Veval_blocks_run) :exports (print export_blocks) :comments both
 :END:
@@ -731,7 +731,7 @@ V0_g                         11.3047276743,14.0732311562,15.4214195361,16.354176
   run(inp, label=name)
 #+end_src
 
-*** XRF7
+*** COMMENT XRF7
 #+NAME: XRF7
 #+begin_src python  :noweb yes :results none :var name=(org-element-property :name (org-element-context))
 
@@ -755,7 +755,7 @@ V0_g                         11.3047276743,14.0732311562,15.4214195361,16.354176
 
   run(inp, label=name)
 #+end_src
-*** XRF8
+*** COMMENT XRF8
 #+NAME: XRF8
 #+begin_src python  :noweb yes :results none :var name=(org-element-property :name (org-element-context))
 

diff --git a/docs/reports/CPC24/sec_examples.org b/docs/reports/CPC24/sec_examples.org
@@ -1,6 +1,6 @@
 #+setupfile: ./config.org
 # https://stackoverflow.com/questions/44414584/how-to-export-a-org-mode-table-to-latex-with-the-correct-placement-h
-* House keeping  :noexport: 
+* House keeping  
 #+begin_src elisp :results none :tangle no :exports none
   (add-to-list 'org-structure-template-alist
   '("sp" . "src python :session (print pythonShell)"))
@@ -12,19 +12,19 @@
         '("latexmk -pdflatex='pdflatex --syntex=1 -shell-escape -interaction nonstopmode' -pdf -bibtex -f %f"
           "latexmk -pdflatex='pdflatex --syntex=1 -shell-escape -interaction nonstopmode' -pdf -bibtex -f %f"))
   ;; (setq org-latex-pdf-process (list "latexmk -f -pdf -interaction=nonstopmode -output-directory=%o %f"))
-  (pyvenv-workon "feniax.)
+  (pyvenv-workon "feniax")
   (require 'org-tempo)
   ;; Veval_blocks -> eval blocks of latex
   ;; Veval_blocks_run -> eval blocks to obtain results
   (setq Veval_blocks "yes") ;; yes, no, no-export 
-  (setq Veval_blocks_run "no-export")
+  (setq Veval_blocks_run "yes")
   (setq pythonShell "py2")
   (setq Vpics "png") ;; yes, no, no-export   
   ;; export_blocks: code, results, both, none
-  (setq export_blocks  "results")  
+  (setq export_blocks  "both")  
 #+end_src
 
-* Load modules :noexport: 
+* Load modules 
 :PROPERTIES:
 :header-args: :mkdirp yes  :session (print pythonShell) :noweb yes  :eval (print Veval_blocks) :exports (print export_blocks) :comments both
 :END:
@@ -77,7 +77,8 @@
   from tabulate import tabulate
 
 #+end_src
-* Plotting :noexport: 
+
+* Plotting 
 :PROPERTIES:
 :header-args:  :session (print pythonShell) :noweb yes :tangle ./results/examples.py :eval (print Veval_blocks) :exports (print export_blocks) :comments both
 :END:
@@ -954,7 +955,7 @@ Geometric nonlinearities are better illustrated by representing a sectional view
 #+CAPTION: Static geometrically-nonlinear effects on the aircraft main wing 
 #+ATTR_LATEX: :width 0.5\textwidth 
 #+RESULTS: SPWingsection
-[[file:figs/SPWingsection.png]]
+[[file:]]
 
 The tolerance in the Newton solver was set to $10^{-6}$ in all cases.
 A convergence analysis with the number of modes in the solution is presented in Fig. [[SPstatic_convergence]].

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -117,7 +117,9 @@ nav:
   #     - Theoretical Background:
   #     - Running:
   #- Tutorials
-  - Examples: examples.md
+  - Examples:
+      - CPC_runs: examples/runs.md #../reports/CPC24/runs.md
+      - CPC_examples: examples/cpc_examples.md
   #- Postprocessing
   - Theoretical background:
       - Intrinsic modal description: theory_intrinsic.md

diff --git a/pyproject.toml b/pyproject.toml
@@ -52,6 +52,7 @@ postprocessing = ["matplotlib",
                   "plotly",
             	  "pyvista",
 		  "streamlit",
+		  "kaleido",
               	  "stpyvista",
             	  "streamlit-pdf-viewer"
 		  ]
@@ -62,6 +63,7 @@ all = ["pytest",
        "plotly",
        "pyvista",
        "streamlit",
+       "kaleido",
        "stpyvista",
        "streamlit-pdf-viewer"
       ]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		/Users/ac5015/projects/FENIAX/docs/reports/CPC24/figs