From 151586cc49c53cccf0cf7acf35347c1202c83822 Mon Sep 17 00:00:00 2001 From: Meakk Date: Tue, 31 Dec 2024 08:49:16 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20f3d-app/?= =?UTF-8?q?f3d@3f92f0b39def3d810b44decb9ccecb776124da46=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/js/search-data.json | 2 +- doc/dev/GETTING_STARTED.html | 2 +- doc/dev/GETTING_STARTED.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/assets/js/search-data.json b/assets/js/search-data.json index 200abe5704..c493315871 100644 --- a/assets/js/search-data.json +++ b/assets/js/search-data.json @@ -78,7 +78,7 @@ },"11": { "doc": "Getting Started", "title": "Getting Started", - "content": "# Getting started guide This is a getting started guide, aimed to people that are not used to C++ programming, configuring and compiling. If you are already used to such processes, you may be looking for our [build guide](/doc/dev/BUILD.html). This guide will help you to compile your own version of F3D with required dependencies. Optional dependencies or covered in the build guide. - If you are using [Linux](#linux) - If you are using [Windows](#windows) - If you are using [macOS](#macos) ## Linux Note: The following steps were tested with Ubuntu 23 and ArchLinux but should work for other OSes as stated, as long as listed packages are available. ### Install dependencies First make sure your system is up-to-date, then install the required dependencies using the terminal. #### Debian/Ubuntu/Mint ``` sudo apt update sudo apt upgrade sudo apt install build-essential git git-lfs cmake libvtk9-dev ``` #### Fedora/Centos/RedHat ``` sudo yum update sudo yum install make automake gcc gcc-c++ kernel-devel git git-lfs cmake vtk ``` #### Arch Linux ``` sudo pacman -Syu sudo pacman -S base-devel git git-lfs cmake vtk nlohmann-json hdf5 netcdf fmt verdict openmpi glew ospray boost libxcursor ``` ### Compile F3D Open a terminal. ``` mkdir f3d cd f3d git clone https://github.com/f3d-app/f3d src mkdir build cd build cmake ../src make ``` You can then simply run F3D from the command line: ``` ./bin/f3d ``` ### Running the test suite ``` cmake -DBUILD_TESTING=ON ../src make ctest ``` ## Windows Note: The following steps were tested with Visual Studio Community 2022 using Windows 10, but should also work for other versions #### Install Dependencies * Download and install [git bash for windows][gitforwindows] * Download and install [cmake][cmake-download] * Download and install [Visual Studio 2022 Community Edition][visual-studio] #### Recover F3D sources * Open git bash ```sh cd C: mkdir dev cd dev mkdir f3d cd f3d git clone https://github.com/f3d-app/f3d.git src mkdir build ``` #### Install dependencies using vcpkg * Open git bash ```sh cd C:/dev git clone https://github.com/Microsoft/vcpkg.git cd vcpkg git fetch origin c9140a3b500812ad3206317885860d9553b93f13 ``` * Open cmd ```sh cd C:\\dev .\\vcpkg\\bootstrap-vcpkg.bat cmake -B .\\f3d\\build -S .\\f3d\\src -DCMAKE_TOOLCHAIN_FILE=C:\\dev\\vcpkg\\scripts\\buildsystems\\vcpkg.cmake ``` Note: Last command will take a while. It download, compile and install all dependencies, including many optional ones. #### Build F3D * Open cmd ```sh cd C:\\dev\\f3d\\build cmake . cmake --build . ``` #### Run * Double click on the `C:\\dev\\f3d\\build\\bin_Debug\\f3d.exe` executable ### Running the test suite ``` cmake -DBUILD_TESTING=ON . cmake --build . --config Release ctest -C Release ``` ## macOS Note: The following steps were tested with macOS Catalina using Xcode 12.4, but should also work for other versions ### Install Xcode There are different ways to install Xcode, you can use the AppStore or download it from apple developer website and then extract and install it. ### Install Homebrew Open a terminal. ``` /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\" (echo; echo 'eval \"$(/opt/homebrew/bin/brew shellenv)\"') >> ~/.zprofile eval \"$(/opt/homebrew/bin/brew shellenv)\" ``` ### Install dependencies Open a terminal. ``` brew install git git-lfs cmake curl vtk git lfs install ``` Note: Homebrew is downloading, compiling and installing all vtk dependencies. This command may take a very long time. ### Compile F3D Open a terminal. ``` mkdir f3d cd f3d git clone https://github.com/f3d-app/f3d src mkdir build cd build cmake ../src make ``` You can then simply run F3D from the command line: ``` ./bin/f3d.app/Contents/MacOS/f3d ``` ### Running the test suite ``` cmake -DBUILD_TESTING=ON ../src make ctest ``` [cmake-download]: https://cmake.org/download [gitforwindows]: https://gitforwindows.org/ [visual-studio]: https://visualstudio.microsoft.com/vs/community/ ", + "content": "# Getting started guide This is a getting started guide, aimed to people that are not used to C++ programming, configuring and compiling. If you are already used to such processes, you may be looking for our [build guide](/doc/dev/BUILD.html). This guide will help you to compile your own version of F3D with required dependencies. Optional dependencies or covered in the build guide. - If you are using [Linux](#linux) - If you are using [Windows](#windows) - If you are using [macOS](#macos) ## Linux Note: The following steps were tested with Ubuntu 23 and ArchLinux but should work for other OSes as stated, as long as listed packages are available. ### Install dependencies First make sure your system is up-to-date, then install the required dependencies using the terminal. #### Debian/Ubuntu/Mint ``` sudo apt update sudo apt upgrade sudo apt install build-essential git git-lfs cmake libvtk9-dev ``` #### Fedora/Centos/RedHat ``` sudo yum update sudo yum install make automake gcc gcc-c++ kernel-devel git git-lfs cmake vtk ``` #### Arch Linux ``` sudo pacman -Syu sudo pacman -S base-devel git git-lfs cmake vtk nlohmann-json hdf5 netcdf fmt verdict openmpi glew ospray libxcursor ``` ### Compile F3D Open a terminal. ``` mkdir f3d cd f3d git clone https://github.com/f3d-app/f3d src mkdir build cd build cmake ../src make ``` You can then simply run F3D from the command line: ``` ./bin/f3d ``` ### Running the test suite ``` cmake -DBUILD_TESTING=ON ../src make ctest ``` ## Windows Note: The following steps were tested with Visual Studio Community 2022 using Windows 10, but should also work for other versions #### Install Dependencies * Download and install [git bash for windows][gitforwindows] * Download and install [cmake][cmake-download] * Download and install [Visual Studio 2022 Community Edition][visual-studio] #### Recover F3D sources * Open git bash ```sh cd C: mkdir dev cd dev mkdir f3d cd f3d git clone https://github.com/f3d-app/f3d.git src mkdir build ``` #### Install dependencies using vcpkg * Open git bash ```sh cd C:/dev git clone https://github.com/Microsoft/vcpkg.git cd vcpkg git fetch origin c9140a3b500812ad3206317885860d9553b93f13 ``` * Open cmd ```sh cd C:\\dev .\\vcpkg\\bootstrap-vcpkg.bat cmake -B .\\f3d\\build -S .\\f3d\\src -DCMAKE_TOOLCHAIN_FILE=C:\\dev\\vcpkg\\scripts\\buildsystems\\vcpkg.cmake ``` Note: Last command will take a while. It download, compile and install all dependencies, including many optional ones. #### Build F3D * Open cmd ```sh cd C:\\dev\\f3d\\build cmake . cmake --build . ``` #### Run * Double click on the `C:\\dev\\f3d\\build\\bin_Debug\\f3d.exe` executable ### Running the test suite ``` cmake -DBUILD_TESTING=ON . cmake --build . --config Release ctest -C Release ``` ## macOS Note: The following steps were tested with macOS Catalina using Xcode 12.4, but should also work for other versions ### Install Xcode There are different ways to install Xcode, you can use the AppStore or download it from apple developer website and then extract and install it. ### Install Homebrew Open a terminal. ``` /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\" (echo; echo 'eval \"$(/opt/homebrew/bin/brew shellenv)\"') >> ~/.zprofile eval \"$(/opt/homebrew/bin/brew shellenv)\" ``` ### Install dependencies Open a terminal. ``` brew install git git-lfs cmake curl vtk git lfs install ``` Note: Homebrew is downloading, compiling and installing all vtk dependencies. This command may take a very long time. ### Compile F3D Open a terminal. ``` mkdir f3d cd f3d git clone https://github.com/f3d-app/f3d src mkdir build cd build cmake ../src make ``` You can then simply run F3D from the command line: ``` ./bin/f3d.app/Contents/MacOS/f3d ``` ### Running the test suite ``` cmake -DBUILD_TESTING=ON ../src make ctest ``` [cmake-download]: https://cmake.org/download [gitforwindows]: https://gitforwindows.org/ [visual-studio]: https://visualstudio.microsoft.com/vs/community/ ", "url": "/doc/dev/GETTING_STARTED.html", "relUrl": "/doc/dev/GETTING_STARTED.html" diff --git a/doc/dev/GETTING_STARTED.html b/doc/dev/GETTING_STARTED.html index 083152a5a8..1edafcb35d 100644 --- a/doc/dev/GETTING_STARTED.html +++ b/doc/dev/GETTING_STARTED.html @@ -4,7 +4,7 @@

Fedora/Centos/RedHat 

sudo yum update
 sudo yum install make automake gcc gcc-c++ kernel-devel git git-lfs cmake vtk

Arch Linux 

sudo pacman -Syu
-sudo pacman -S base-devel git git-lfs cmake vtk nlohmann-json hdf5 netcdf fmt verdict openmpi glew ospray boost libxcursor
+sudo pacman -S base-devel git git-lfs cmake vtk nlohmann-json hdf5 netcdf fmt verdict openmpi glew ospray libxcursor

Compile F3D

Open a terminal.

mkdir f3d
 cd f3d
 git clone https://github.com/f3d-app/f3d src
diff --git a/doc/dev/GETTING_STARTED.md b/doc/dev/GETTING_STARTED.md
index 251d4493ac..983d2d9c1c 100644
--- a/doc/dev/GETTING_STARTED.md
+++ b/doc/dev/GETTING_STARTED.md
@@ -40,7 +40,7 @@ sudo yum install make automake gcc gcc-c++ kernel-devel git git-lfs cmake vtk
 
 ```
 sudo pacman -Syu
-sudo pacman -S base-devel git git-lfs cmake vtk nlohmann-json hdf5 netcdf fmt verdict openmpi glew ospray boost libxcursor
+sudo pacman -S base-devel git git-lfs cmake vtk nlohmann-json hdf5 netcdf fmt verdict openmpi glew ospray libxcursor
 ```
 
 ### Compile F3D