Skip to content

Commit 978694b

Browse files
author
Eduardo Guzman Maldonado
committed
Merge branch '6-create-a-new-landing-page' into 'main'
Resolve "Create a new landing page" Closes #6 See merge request comfor/comfor-doc!29
2 parents 7cf2970 + ea04fe0 commit 978694b

22 files changed

Lines changed: 1245 additions & 307 deletions

.gitlab-ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ pages:
3939
- cp extra/googlef388943a115bc8cc.html public/en/googlef388943a115bc8cc.html
4040
- cp extra/googlef388943a115bc8cc.html public/fr/googlef388943a115bc8cc.html
4141
- cp extra/robots.txt public/robots.txt
42+
- cp extra/index.html public/index.html
4243
artifacts:
4344
paths:
4445
- public

config/en/mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ theme:
5151
favicon: assets/img/apple-touch-icon-72x72.png
5252
language: en
5353
font:
54-
text: Roboto
55-
code: Roboto Mono
54+
text: Geist
55+
code: JetBrains Mono
5656
palette:
5757
- media: "(prefers-color-scheme: light)" # Automatic gestion of user's preferences
5858
scheme: default # Light theme
@@ -146,7 +146,7 @@ extra_javascript:
146146
# - assets/js/background_effects.js
147147

148148
extra_css:
149-
# - assets/css/landing_page.css
149+
- assets/css/landing_page.css
150150
- assets/css/faq_admonition.css
151151
# - assets/css/tabbed.css
152152
# - assets/css/home_page.css

docs/en/docs/analysis.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
As seen before, the pre-processing operation consist in generating the input ASCII text file of the model. The next step is to run comfor using this input file. The analysis will be performed and Comfor is going to generate several output files : Paraview files, CSV files and log files.
1+
As seen before, the pre-processing step consists of generating the model input file in ASCII text format. The next step is to run Comfor using this input file. The analysis is then performed, and Comfor generates several output files: ParaView files, CSV files, and log files.
22

33
# Starting a new analysis
44

5-
Comfor is execute from the terminal(command line) using the following syntax:
5+
Comfor is executed from the terminal (command line) using the following syntax:
66

77
```bash
88
comfor <input_file_name>
99
```
1010

11-
- `<input_file_name>`: is the relatif or full path name to the input file. If the file is placed in the same folder of the comfor binary, you should indicate only the file name.
11+
- `<input_file_name>`: the relative or absolute path to the input file. If the file is located in the same folder as the Comfor binary, you only need to provide the file name.
1212

1313
_Examples_:
1414

@@ -21,9 +21,9 @@ $ comfor /usr/name/sim/test.bim
2121

2222
# Run time information
2323

24-
During the analysis, Comfor will print periodically some useful information on the terminal. The frequency is the defined by the [`print_step`](preprocessing.md#control) defined in the control block.
24+
During the analysis, Comfor periodically prints useful information to the terminal. The frequency is defined by [`print_step`](preprocessing.md#control) in the control block.
2525

26-
The output information is given by block with the general structure:
26+
The output information is displayed in blocks with the following structure:
2727

2828
```console
2929
=================================
@@ -35,19 +35,19 @@ Kinetic energy: 0.0110008
3535
=================================
3636
```
3737

38-
- `Elapsed time`: Is the user CPU time (real time) from the beginning of the simulation.
39-
- `Current time`: Is current time of the simulation
40-
- `Time step`: Is the current minimum time step of the whole model.
41-
- `Internal energy`: Is the energy generate by the internal forces int the whole model.
42-
- `Kinetic energy`: Is the kinetic energy in the whole model.
38+
- `Elapsed time`: User CPU time (wall-clock time) since the beginning of the simulation.
39+
- `Current time`: Current simulation time.
40+
- `Time step`: Current minimum time step in the model.
41+
- `Internal energy`: Energy generated by the internal forces in the model.
42+
- `Kinetic energy`: Kinetic energy of the model.
4343

4444
!!! tip
45-
To stop a job just press ++ctrl+c++
45+
To stop a job, just press ++ctrl+c++.
4646

4747
# Output
4848

49-
A new folder named `Results_<file_name>` is created in the same directory of the input file. This folder contains a série of \*.vtk files which can be viewed using paraview.
49+
A new folder named `Results_<file_name>` is created in the same directory as the input file. This folder contains a series of `*.vtk` files that can be viewed with ParaView.
5050

5151
# Errors and bugs
5252

53-
If any error occurs, please [contact us]()
53+
If an error occurs, please [contact us]().

0 commit comments

Comments
 (0)