Skip to content

Commit 7c2ef36

Browse files
readme
1 parent c2f7d02 commit 7c2ef36

2 files changed

Lines changed: 17 additions & 11 deletions

File tree

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/36d3d305c87e4bb398bc87ea2e3b890e)](https://www.codacy.com/gh/KratosMultiphysics/GiDInterface/dashboard?utm_source=github.com&utm_medium=referral&utm_content=KratosMultiphysics/GiDInterface&utm_campaign=Badge_Grade)
44
[![Tester](https://github.com/KratosMultiphysics/GiDInterface/actions/workflows/tester.yml/badge.svg)](https://github.com/KratosMultiphysics/GiDInterface/actions/workflows/tester.yml)
55

6-
The user interface of Kratos with [GiD](http://www.gidhome.com).
6+
The user interface of Kratos with [GiD](http://www.gidsimulation.com).
77

88
If you need the latest stable release, launch your GiD, navigate to Data > Problemtype > Internet retrieve and download Kratos there.
99
Available for Linux. Windows, and macOS.
@@ -12,35 +12,41 @@ If you need the developer version, you are on the right place.
1212

1313
## First steps
1414
* 1- Clone this repository, or install a stable [release](https://github.com/KratosMultiphysics/GiDInterface/releases)
15-
* 2- Install the latest GiD developer version -> [Developer version](http://www.gidhome.com/download/developer-versions)
15+
* 2- Install the latest GiD developer version **(minimum 16.1.4d)** -> [Developer version](https://www.gidsimulation.com/gid-for-science/downloads/)
1616
* 3- Navigate to GiD's problemtype folder and delete any previous kratos.gid
1717
* Create there a link to our [kratos.gid](./kratos.gid/) downloaded in step 1
1818
* Windows: Simple shortcut to kratos.gid folder
1919
* 4- Choose your execution mode:
20+
* 4.1- **Default execution mode.** Use GiD's python:
21+
* You don't need to install python. The program will detect if you have any pending package to install.
22+
* If there's any missing package, use the GiD command line and execute:
23+
24+
`-np- W [GiD_Python_PipInstallMissingPackages [list $Kratos::pip_packages_required ] ]`
2025
* 4.1- To execute Kratos using the standard pip packages:
21-
* Python version recommended: 3.9
26+
* Python version recommended: 3.8, 3.9, 3.10, 3.11
2227
* Open a terminal and run
2328
- Linux: `python3 -m pip install --upgrade --force-reinstall --no-cache-dir KratosMultiphysics-all==9.3.2`
2429
- Windows: `python -m pip install --upgrade --force-reinstall --no-cache-dir KratosMultiphysics-all==9.3.2`
2530
* 4.2- To execute Kratos using your compiled binaries:
26-
* Navigate to kratos.gid/exec/
27-
* Create there a symbolic link to the kratos installation folder (where runkratos is located)
28-
* Unix : `ln -s ~/Kratos Kratos` or maybe `ln -s ~/Kratos/bin/Release Kratos` if that's the destination folder
29-
* Windows : `mklink /J Kratos C:\kratos\bin\Release` (choose actual Kratos installation folder)
31+
* Fill the Kratos preferences windows with
32+
- Path to the python folder
33+
- Path to the kratos build folder
3034
* Step by step video: https://www.youtube.com/watch?v=zZq7ypDdudo
31-
* 4.3- To execute Kratos using docker, just install docker
35+
* 4.3- To execute Kratos using docker, just install docker.
36+
* Note: This is the ONLY option if you are a **macOS** user at this moment
3237

3338
### Launch modes
3439
In Kratos preferences, select the execution mode:
40+
* GiD's python: Use the GiD internal python to run. It will help you install the pip packages
3541
* Pip packages: Kratos will be installed via `pip install`
3642
* local compiled: If you are a developer and build your applications, use this one
3743
* docker: If you do not want to install any dependency, just run via docker!
3844
* The default image is [fjgarate/kratos-run](https://hub.docker.com/repository/docker/fjgarate/kratos-run)
3945

4046
### Usage
4147
* Run GiD
42-
* Go to: Data / Problem type / kratos
43-
* kratos top menu / Developer mode (recommended)
48+
* Go to top menu: Data / Problem type / kratos
49+
* Go to top menu: kratos / Preferences / Developer mode (recommended)
4450

4551
### Examples
4652
* [Fluid dynamics example](https://github.com/KratosMultiphysics/Kratos/wiki/Running-an-example-from-GiD#3-set-a-fluid-dynamics-problem)

kratos.gid/scripts/Launch.tcl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ proc Kratos::InstallAllPythonDependencies { } {
3232
}
3333

3434
proc Kratos::InstallPip { } {
35-
W ""
35+
# W ""
3636
}
3737

3838
proc Kratos::GetPythonExeName { } {

0 commit comments

Comments
 (0)