Skip to content

Commit

Permalink
Fix typos in INSTALL, README and CMakeLists.txt
Browse files Browse the repository at this point in the history
Found via codespell
  • Loading branch information
luzpaz committed Feb 26, 2025
1 parent 959a9d9 commit 3ce0a25
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 23 deletions.
8 changes: 4 additions & 4 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ elseif (KRATOS_SHARED_MEMORY_PARALLELIZATION STREQUAL "None")
message(STATUS "Shared memory parallelization is disabled!")

else()
message(FATAL_ERROR "Invalid option choosen for \"KRATOS_SHARED_MEMORY_PARALLELIZATION\"! Available options are: \"OpenMP\", \"C++11\", \"None\"")
message(FATAL_ERROR "Invalid option chosen for \"KRATOS_SHARED_MEMORY_PARALLELIZATION\"! Available options are: \"OpenMP\", \"C++11\", \"None\"")
endif ()

OPTION(KRATOS_NO_TRY_CATCH "Disabled the use of try/catch through the code" OFF)
Expand Down Expand Up @@ -551,7 +551,7 @@ endif(${USE_TETGEN_NONFREE_TPL} MATCHES ON)
# Setting MPI
if(${USE_MPI} MATCHES ON )
find_package(MPI REQUIRED)
# supress anoying warnings from trilinos due to not having the same package name as the lib name.
# suppress annoying warnings from trilinos due to not having the same package name as the lib name.
if(NOT DEFINED CMAKE_SUPPRESS_DEVELOPER_WARNINGS)
set(CMAKE_SUPPRESS_DEVELOPER_WARNINGS 1 CACHE INTERNAL "No dev warnings")
endif()
Expand Down Expand Up @@ -580,7 +580,7 @@ if( FORCE_LOCAL_ZLIB_COMPILATION MATCHES OFF )
endif( ZLIB_FOUND )
endif( FORCE_LOCAL_ZLIB_COMPILATION MATCHES OFF )

# We local compilate ZLIB
# We compile ZLIB locally
if( FORCE_LOCAL_ZLIB_COMPILATION MATCHES ON )
message(STATUS "Preparing local ZLIB compilation.")
include_directories( ${KRATOS_SOURCE_DIR}/external_libraries/zlib )
Expand Down Expand Up @@ -613,7 +613,7 @@ if (${KRATOS_ENABLE_PROFILING} MATCHES ON)
endif()

# Build exclusions and linking dirs.
# The intended usage of this flags is to allow a defered/incremental compilation of core/applications.
# The intended usage of this flags is to allow a deferred/incremental compilation of core/applications.
# Please do not use this options for regular development and never use this with REMOVE_INSTALL_DIRECTORIES=ON
OPTION ( EXCLUDE_KRATOS_CORE "Force exclusion of the core" OFF )
OPTION ( EXCLUDE_AUTOMATIC_DEPENDENCIES "Force exclusion of automatically added app dependencies" OFF )
Expand Down
36 changes: 18 additions & 18 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ git clone https://github.com/KratosMultiphysics/Kratos Kratos
## Kratos Dependencies

### Kratos Core Dependencies
These are the basic dependecies needed to compile the *Kratos* Core and most of the *Kratos* applications.
These are the basic dependencies needed to compile the *Kratos* Core and most of the *Kratos* applications.
* Python3-dev
* C++17 compiler
* CMake
* Boost (dependencies are header-only, no compilation of boost libraries required)

Additionaly, Visual Studio is required to compile in *Windows*.
Additionally, Visual Studio is required to compile in *Windows*.

- #### GNU/Linux-WSL installation

Expand All @@ -76,11 +76,11 @@ Additionaly, Visual Studio is required to compile in *Windows*.

- Visual Studio

*Visual Studio* is the only compiler officially supported to build *Kratos* under *Windows*. The minimium required version is *Visual Studio 2019* or higher (please ensure that version is at least 16.8 or MSVC version is at least 19.24).
*Visual Studio* is the only compiler officially supported to build *Kratos* under *Windows*. The minimum required version is *Visual Studio 2019* or higher (please ensure that version is at least 16.8 or MSVC version is at least 19.24).

* [Download Visual Studio](https://visualstudio.microsoft.com/en/thank-you-downloading-visual-studio/?sku=Community&rel=16)

Since *Visual Studio* is a multi-language IDE, some distributions come without C++ compiler. Please, make sure that you can create a C++ project before continuing, in case C++ packages were missing you will be prompt to download them. You can install the **Desktop development with C++** workload with the Visual Studio Installer to acquire all necessary depencencies to compile C++ projects.
Since *Visual Studio* is a multi-language IDE, some distributions come without C++ compiler. Please, make sure that you can create a C++ project before continuing, in case C++ packages were missing you will be prompt to download them. You can install the **Desktop development with C++** workload with the Visual Studio Installer to acquire all necessary dependencies to compile C++ projects.

When compiling *Kratos* in *Windows*, please take into consideration the [Windows Visual Studio compilation configuration](#Windows-Visual-Studio-compilation-configuration).

Expand Down Expand Up @@ -193,7 +193,7 @@ Additionaly, Visual Studio is required to compile in *Windows*.
- *MSYS2*
First, we download *MSYS2* in the following [link](https://www.msys2.org/). This will install *MinGW*, which allows to easiy install packages *a la* Arch-Linux (Pacman package manager). We install it, and with it the first thing we do is to update as follows ([in the *MSYS2* bash](https://www.msys2.org/docs/terminals/)):
First, we download *MSYS2* in the following [link](https://www.msys2.org/). This will install *MinGW*, which allows to easily install packages *a la* Arch-Linux (Pacman package manager). We install it, and with it the first thing we do is to update as follows ([in the *MSYS2* bash](https://www.msys2.org/docs/terminals/)):
![](https://www.msys2.org/docs/mintty.png) ![](https://www.msys2.org/docs/launchers.png)
```Shell
Expand Down Expand Up @@ -270,11 +270,11 @@ Compilation Type. Options are `Release`,`RelWithDebInfo`,`Debug`,`FullDebug`,`Cu

**Release**: Full Release with maximum optimization options and no debug Info.

**RelWithDebInfo**: Full Release with optimization and debug info. Adecuate to debug simple problems without losing performance.
**RelWithDebInfo**: Full Release with optimization and debug info. Adequate to debug simple problems without losing performance.

**Debug**: Debug build with no optimization flags.

**FullDebug**: Debug build with no optimization flags, extended debug info and extremly low performance.
**FullDebug**: Debug build with no optimization flags, extended debug info and extremely low performance.

**Custom**: No flags are automatically added.

Expand Down Expand Up @@ -350,7 +350,7 @@ rm -rf "${KRATOS_BUILD}/${KRATOS_BUILD_TYPE}/CMakeFiles"
# Configure
cmake -H"${KRATOS_SOURCE}" -B"${KRATOS_BUILD}/${KRATOS_BUILD_TYPE}" -DUSE_MPI=OFF -DUSE_EIGEN_MKL=OFF
# Buid
# Build
cmake --build "${KRATOS_BUILD}/${KRATOS_BUILD_TYPE}" --target install -- -j4
```
Expand Down Expand Up @@ -493,7 +493,7 @@ cmake ..
-DKRATOS_SHARED_MEMORY_PARALLELIZATION="${KRATOS_SHARED_MEMORY_PARALLELIZATION}" \
-DUSE_EIGEN_MKL=OFF
# Buid
# Build
cmake --build "${KRATOS_BUILD}/${KRATOS_BUILD_TYPE}" --target install -- -j$(nproc)
```
Expand Down Expand Up @@ -638,7 +638,7 @@ rm -rf "${KRATOS_BUILD}/${KRATOS_BUILD_TYPE}/CMakeFiles"
-DCMAKE_C_FLAGS="${CMAKE_C_FLAGS} -msse3 -L/usr/local/opt/llvm/lib" \
-DUSE_EIGEN_MKL=OFF
# Buid
# Build
/Applications/CMake.app/Contents/bin/cmake --build "${KRATOS_BUILD}/${KRATOS_BUILD_TYPE}" --target install -- -j3
```
Expand Down Expand Up @@ -720,16 +720,16 @@ We provide several flavours in order to parallelize *Kratos* compilation. We hav
*GNU/Linux* builds should automatically make use of the maximum number of threads in your computer which is passed to the compiler in the `-j$(nproc)` flag on the last line of the configure file:
```
# Buid
# Build
cmake --build "${KRATOS_BUILD}/${KRATOS_BUILD_TYPE}" --target install -- -j$(nproc)
```
If your *GNU/Linux* flavour does not support the `$(nproc)` shortcut or you simply want to tune this value to some of your liking, you can change it:
```
# Buid (This will make it compile with 2 threads)
# Build (This will make it compile with 2 threads)
cmake --build "${KRATOS_BUILD}/${KRATOS_BUILD_TYPE}" --target install -- -j2
```
**Warning**: Please be carefull while mixing parallel builds with unitay builds. See [below](#unitary-builds)
**Warning**: Please be careful while mixing parallel builds with unitay builds. See [below](#unitary-builds)
#### Windows
Expand All @@ -745,7 +745,7 @@ rem set KRATOS_PARALLEL_BUILD_FLAG=/MPX
This will pass the `/MPX` option directly to `CL.exe`, where `X` is the number of threads you want to use.
If you preffer to interact directly with `MSBuild.exe` you can use either of this options in the cmake build command:
If you prefer to interact directly with `MSBuild.exe` you can use either of this options in the cmake build command:
- `/p:CL_MPcount=X`: Enable multiples cpp to be compiled in parallel
- `/m:x`: Enable multiple applications to be compiled in parallel
Expand Down Expand Up @@ -783,7 +783,7 @@ Build directory for *Kratos*. Makefiles, vsprojects and other artifacts will be
Path where your applications are located. This variable is not necessary but it helps to organize the list of applications to be compiled. It defaults to `Kratos/Applications`
`KRATOS_INSTALL_PYTHON_USING_LINKS=ON/OFF`
Controls wether the python files are installed by making copies or creating symlinks to the files in the source directory. This options is specially usefull if you are developing python files and don't want to reinstall every time you touch a script.
Controls whether the python files are installed by making copies or creating symlinks to the files in the source directory. This options is specially useful if you are developing python files and don't want to reinstall every time you touch a script.
Using this option in *Windows* requires elevated privileges (you must run the script as admin)
Expand All @@ -807,10 +807,10 @@ User defined flags for the C compiler.
User defined flags for the C++ compiler.
`-DBOOST_ROOT=String`
Root directory for boost. Overrided by `BOOST_ROOT` environmental variable if defined.
Root directory for boost. Overridden by `BOOST_ROOT` environmental variable if defined.
`-DPYTHON_EXECUTABLE=String`
Python executable to be used. It is recommended to set this option if more than one version of python is present in the system (For example while using ubuntu). Overrided by `PYTHON_EXECUTABLE` environmental variable if defined.
Python executable to be used. It is recommended to set this option if more than one version of python is present in the system (For example while using ubuntu). Overridden by `PYTHON_EXECUTABLE` environmental variable if defined.
`-DKRATOS_BUILD_TESTING=ON/OFF`
Enables(Default) or Disables the compilation of the C++ unitary tests for *Kratos* and Applications.
Expand All @@ -837,7 +837,7 @@ cmake --build "%KRATOS_BUILD%/%KRATOS_BUILD_TYPE%" --target install -- /property
Instead of the regular install target.
Please, beware that using this flag along with a parallel compilation may cause a **VERY LARGE** use of RAM as we hardcoded *Kratos* compilation so unitary builds try to make as many unitary targets as threads are usable.
We recommed you to disable parallel compilation unless you know what you are doing.
We recommend you to disable parallel compilation unless you know what you are doing.
### Parallelism
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

_KRATOS Multiphysics_ ("Kratos") is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface. More in [Overview](https://github.com/KratosMultiphysics/Kratos/wiki/Overview)

**Kratos** is **free** under BSD-4 [license](https://github.com/KratosMultiphysics/Kratos/blob/master/kratos/license.txt) and can be used even in comercial softwares as it is. Many of its main applications are also free and BSD-4 licensed but each derived application can have its own propietary license.
**Kratos** is **free** under BSD-4 [license](https://github.com/KratosMultiphysics/Kratos/blob/master/kratos/license.txt) and can be used even in commercial software as it is. Many of its main applications are also free and BSD-4 licensed but each derived application can have its own proprietary license.

# Main Features
**Kratos** is __multiplatform__ and available for __Windows, Linux__ (several distros) and __macOS__.
Expand Down

0 comments on commit 3ce0a25

Please sign in to comment.