Skip to content

Commit 8a0bf9e

Browse files
committed
Update the download links.
Add installation instructions for Linux.
1 parent e527088 commit 8a0bf9e

File tree

2 files changed

+29
-10
lines changed

2 files changed

+29
-10
lines changed

docs/installation_guide.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ the latest built release, and run some of the example models provided.
55

66
## Installation
77

8-
Currently, binaries are provided for Windows (64-bit) only.
9-
To install the latest release, proceed as follows:
8+
64-bit binaries are now provided for both Windows and Linux (Ubuntu 22.04).
9+
To install the latest Windows release, proceed as follows:
1010

1111
* Go to the [Releases](https://github.com/openfedem/fedem-gui/releases) page
1212
on the [fedem-gui](https://github.com/openfedem/fedem-gui) repository on github,
@@ -26,12 +26,30 @@ To install the latest release, proceed as follows:
2626
That is, download the file [vc_redist.x64.exe](https://aka.ms/vs/17/release/vc_redist.x64.exe)
2727
and execute it as administrator.
2828

29+
To install the latest Linux release,
30+
download the most recent `Fedem-*_Ubuntu-22.04.tar.gz` file
31+
from the [Releases](https://github.com/openfedem/fedem-gui/releases) page
32+
(it is also available from the **Download** menu in the left pane).
33+
34+
Unpack this file in the location where you want to have Fedem installed, e.g.:
35+
36+
$ cd /usr/local
37+
$ sudo tar zxfv ~/Downloads/Fedem-R8.1.0_Ubuntu-22.04.tar.gz
38+
39+
This will install Fedem R8.1.0 in the folder `/usr/local/Fedem-8.1.0`.
40+
41+
Then, install the required Qt6 packages:
42+
43+
$ sudo apt install libqt6core6 libqt6gui6 libqt6widgets6 libqt6opengl6
44+
2945
## First Run
3046

3147
![FEDEM](images/logo.png){: align="right" style="height:40px;width:40px"}
3248
To start FEDEM with an empty model, either double-click the FEDEM icon on the Desktop,
33-
or select in from the Windows Start menu. The welcome screen of the FEDEM GUI
34-
should then (after a few seconds) appear, like this:
49+
or select in from the Windows Start menu. On Linux, execute the launcher script
50+
`/usr/local/Fedem-8.0.1/fedem`.
51+
52+
The welcome screen of the FEDEM GUI should then (after a few seconds) appear, like this:
3553

3654
![Welcome to FEDEM](images/FedemWelcome.png)
3755

@@ -56,7 +74,7 @@ The FEDEM main windows consists of the following items:
5674
which provides information of the status, progress information
5775
and whether a solver process is running.
5876

59-
Refer to the [Users Guide](https://github.com/openfedem/fedem-docs/releases/download/fedem-8.0.9/FedemUsersGuide.pdf)
77+
Refer to the [Users Guide](https://github.com/openfedem/fedem-docs/releases/download/fedem-8.1.0/FedemUsersGuide.pdf)
6078
for further details on the FEDEM GUI.
6179

6280
If you already have a FEDEM model file, the easiest way to open it is to just double-click the file in the Windows file browser.

mkdocs.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ nav:
1212
- Development Setup: development_setup.md
1313
- Python API (fedempy): python_api.md
1414
- Download:
15-
- Windows installer (zip): https://github.com/openfedem/fedem-gui/releases/download/fedem-8.0.9/FedemInstaller-R8.0.9.zip
16-
- Linux solvers (tar.gz): https://github.com/openfedem/fedem-solvers/releases/download/fedem-8.0.9/fedem-solvers-3.9.1_linux64.tar.gz
17-
- fedempy package (tar.gz): https://github.com/openfedem/fedem-solvers/releases/download/fedem-8.0.9/fedempy-3.9.1.tar.gz
15+
- Windows installer (zip): https://github.com/openfedem/fedem-gui/releases/download/fedem-8.1.0/FedemInstaller-R8.1.0.zip
16+
- Linux installation (tar.gz): https://github.com/openfedem/fedem-gui/releases/download/fedem-8.1.0/Fedem-R8.1.0_Ubuntu-22.04.tar.gz
17+
- Linux solvers (tar.gz): https://github.com/openfedem/fedem-solvers/releases/download/fedem-8.1.0/fedem-solvers-4.0.2_linux64.tar.gz
18+
- fedempy package (tar.gz): https://github.com/openfedem/fedem-solvers/releases/download/fedem-8.1.0/fedempy-4.0.2.tar.gz
1819
- Documentation:
19-
- User Guide (PDF): https://github.com/openfedem/fedem-docs/releases/download/fedem-8.0.9/FedemUsersGuide.pdf
20-
- Theory Guide (PDF): https://github.com/openfedem/fedem-docs/releases/download/fedem-8.0.9/FedemTheoryGuide.pdf
20+
- User Guide (PDF): https://github.com/openfedem/fedem-docs/releases/download/fedem-8.1.0/FedemUsersGuide.pdf
21+
- Theory Guide (PDF): https://github.com/openfedem/fedem-docs/releases/download/fedem-8.1.0/FedemTheoryGuide.pdf
2122
- Python API (fedempy): https://openfedem.github.io/fedem-solvers/fedempy/
2223
- Solver source code: https://openfedem.github.io/fedem-solvers/solver/
2324
- Tutorials: tutorials.md

0 commit comments

Comments
 (0)