https://github.com/elmercsc/elmerfem-manuals
Public manuals for Elmer suite (not all)
https://github.com/elmercsc/elmerfem-manuals
Last synced: 7 months ago
JSON representation
Public manuals for Elmer suite (not all)
- Host: GitHub
- URL: https://github.com/elmercsc/elmerfem-manuals
- Owner: ElmerCSC
- License: other
- Created: 2020-10-20T08:04:03.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T10:47:15.000Z (about 2 years ago)
- Last Synced: 2025-01-23T22:41:21.231Z (over 1 year ago)
- Language: TeX
- Size: 64.3 MB
- Stars: 4
- Watchers: 8
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ElmerGUI manual and tutorials
=============================
* This repository includes the source files for building part of the Elmer documentation.
* Currently ElmerGUI Manual and Elmer Tutorials are provided. The other parts of the documentation are not yet in open repository.
* The documentation here is licensed under Creative Commons Attribution-NonCommercial.
Content of the directories
--------------------------
* latex-elmer-getstart - Get Started with Elmer document
* latex-elmergui - latex input files to build ElmerGUI manual
* latex-tex-start - getting started with TeXworks and editing manuals
* latex-tex-template - a template in TeXworks for building new tutorials
* latex-tutorials-CL - latex input files to build tutorials manual without graphical user interface (command-line usage, files explained)
* latex-tutorials-GUI - latex input files to build tutorials manual where ElmerGUI is used
* tutorials-CL-files - sample input output files related to the tutorials without using the graphical user interface
* tutorials-GUI-files - sample input output files related to using ElmerGUI for the tutorials
Building in Linux
-----------------
- To build the documentation requires LaTex being installed.
- To create the documentation under Linux you can open a terminal window in the 'elmerfem-manuals' directory and type "source makedoc.sh".
- If you get an error like 'float.sty not found', then you may need to install the 'extra' package: 'sudo apt-get install texlive-latex-extra'.
Building in Windows
-------------------
- To build with LaTeX in Windows, install 'MikTex'.
- Msys2 has a bash shell that can run the 'source makedoc.sh' script.
- Installing Git usually also installs 'Git Bash' as a right click context menu selection and Git Bash can run the 'source makedoc' script.
TeXworks
--------
- TeXworks is a LaTex editor that can be used to edit a single manual.
- TeXworks can be used in Linux and in Windows. For Windows, installing 'MikTex' will also TeXworks.
- Select 'pdfLaTeX+MakeIndex+BibTeX' in order to build a manual.
- It is suggested to use the TeXworks dictionary 'English - United Kingdom (en-GB) for spelling checks.