-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add individual instructions in seperate files
- Loading branch information
GMarupilla
committed
Apr 9, 2020
1 parent
c96fd05
commit cf2d9d1
Showing
4 changed files
with
168 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <img align="left" width="32px" id="linux" src="https://raw.githubusercontent.com/virtualcell/vcell-solvers/readme_instructions/asserts/ubuntu.png"> | ||
| <h4>Ubuntu</h4> | ||
| <br style="clear:both"/> | ||
|
|
||
| # Requirements | ||
|
|
||
| - git | ||
| - cmake | ||
| - CLION | ||
|
|
||
| ## For configuring the project | ||
|
|
||
| 1. Open CLION go to `File > settings > Build, Execution, Deployement > Toolchains > +` | ||
| Let it detect everything automatically `CMake`, `Make`, `C Complier`, `C++ Compiler` and `Debugger` | ||
| 2. Configure CMake `File > settings > Build, Execution, Deployement > CMake > +` | ||
| - Build type as `Default` | ||
| - Give `CMake options` | ||
| For all solvers | ||
|
|
||
| ``` | ||
| -DCMAKE_PREFIX_PATH="/usr/lib/x86_64-linux-gnu/" | ||
| -DOPTION_TARGET_MESSAGING=OFF | ||
| -DOPTION_TARGET_PARALLEL=OFF | ||
| -DOPTION_TARGET_CHOMBO2D_SOLVER=OFF | ||
| -DOPTION_TARGET_CHOMBO3D_SOLVER=OFF | ||
| -DOPTION_TARGET_SMOLDYN_SOLVER=ON | ||
| -DOPTION_TARGET_FV_SOLVER=ON | ||
| -DOPTION_TARGET_STOCHASTIC_SOLVER=ON | ||
| -DOPTION_TARGET_NFSIM_SOLVER=ON | ||
| -DOPTION_TARGET_MOVINGBOUNDARY_SOLVER=OFF | ||
| -DOPTION_TARGET_SUNDIALS_SOLVER=ON | ||
| -DOPTION_TARGET_HY3S_SOLVERS=OFF | ||
| ``` | ||
| - Generation path `build/bin` | ||
| - Apply all these changes, that builds every solver in `bin` directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <img align="left" width="32px" id="mac-osx" src="https://raw.githubusercontent.com/virtualcell/vcell-solvers/readme_instructions/asserts/macos.png"> | ||
| <h4>Mac OS X (Legacy)</h4> | ||
| <br style="clear:both"/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| <img align="left" width="32px" id="windows" src="https://raw.githubusercontent.com/virtualcell/vcell-solvers/readme_instructions/asserts/windows.png"> | ||
| <h4>Windows</h4> | ||
| <br style="clear:both"/> | ||
|
|
||
|
|
||
| # Requirements: | ||
|
|
||
| - git | ||
| - MinGW | ||
|
|
||
| 1. Download and install the latest MinGW for windows | ||
| 2. Open MinGW | ||
| - Download and install these dependencies | ||
|
|
||
| ``` | ||
| pacman -S git | ||
| pacman --noconfirm -Syu | ||
| pacman --noconfirm -Syyu python mingw-w64-x86_64-gcc | ||
| pacman --noconfirm -S msys/git | ||
| pacman --noconfirm -S mingw64/mingw-w64-x86_64-gcc-fortran | ||
| pacman --noconfirm -S mingw64/mingw-w64-x86_64-cmake | ||
| pacman --noconfirm -S mingw64/mingw-w64-x86_64-doxygen | ||
| pacman --noconfirm -S msys/make | ||
| pacman --noconfirm -S mingw-w64-x86_64-pkg-config | ||
| pacman --noconfirm -S mingw-w64-x86_64-hdf5 | ||
| pacman --noconfirm -S mingw-w64-x86_64-libzip | ||
| pacman --noconfirm -S mingw-w64-x86_64-netcdf | ||
| ``` | ||
| ## For building solvers manually from MinGW | ||
| - redirect to vcell-solvers directory | ||
| - `mkdir -p build/bin` | ||
| - For building all solvers | ||
| ```bash | ||
| cmake -G "Unix Makefiles" \ | ||
| -DCMAKE_BUILD_TYPE="Release" \ | ||
| -DOPTION_TARGET_MESSAGING=OFF \ | ||
| -DOPTION_TARGET_PARALLEL=OFF \ | ||
| -DOPTION_TARGET_CHOMBO2D_SOLVER=OFF \ | ||
| -DOPTION_TARGET_CHOMBO3D_SOLVER=OFF \ | ||
| -DOPTION_TARGET_SMOLDYN_SOLVER=ON \ | ||
| -DOPTION_TARGET_FV_SOLVER=ON \ | ||
| -DOPTION_TARGET_STOCHASTIC_SOLVER=ON \ | ||
| -DOPTION_TARGET_NFSIM_SOLVER=ON \ | ||
| -DOPTION_TARGET_MOVINGBOUNDARY_SOLVER=OFF \ | ||
| -DOPTION_TARGET_SUNDIALS_SOLVER=ON \ | ||
| -DOPTION_TARGET_HY3S_SOLVERS=OFF \ | ||
| .. | ||
| ``` | ||
| `make` | ||
| - :exclamation:**Note: Remove wrongly built NFSim solver and build seperately | ||
| For building NFSim | ||
| - `make clean` | ||
| ``` | ||
| cmake -G "Unix Makefiles" \ | ||
| -DBUILD_SHARED_LIBS=OFF \ | ||
| -DCMAKE_FIND_LIBRARY_SUFFIXES=".a" \ | ||
| -DCMAKE_EXE_LINKER_FLAGS="-static" \ | ||
| -DOPTION_TARGET_MESSAGING=OFF \ | ||
| -DOPTION_TARGET_PARALLEL=OFF \ | ||
| -DOPTION_TARGET_CHOMBO2D_SOLVER=OFF \ | ||
| -DOPTION_TARGET_CHOMBO3D_SOLVER=OFF \ | ||
| -DOPTION_TARGET_SMOLDYN_SOLVER=OFF \ | ||
| -DOPTION_TARGET_FV_SOLVER=OFF \ | ||
| -DOPTION_TARGET_STOCHASTIC_SOLVER=OFF \ | ||
| -DOPTION_TARGET_NFSIM_SOLVER=ON \ | ||
| -DOPTION_TARGET_MOVINGBOUNDARY_SOLVER=OFF \ | ||
| -DOPTION_TARGET_SUNDIALS_SOLVER=OFF \ | ||
| -DOPTION_TARGET_HY3S_SOLVERS=OFF \ | ||
| .. | ||
| ``` | ||
| `make` | ||
| ## For building solvers manually from powershell | ||
| - Open powershell and redirect to vcell-solvers directory | ||
| - Export the path `$Env:Path = "c:\msys64\mingw64\bin" + ";" + "c:\msys64\usr\bin" + ";" + $Env:Path` | ||
| - `mkdir -p build/bin` | ||
| - `cd build` | ||
| - Building all solvers | ||
| ``` | ||
| cmake -G "Unix Makefiles" ` | ||
| -DCMAKE_BUILD_TYPE="Release" ` | ||
| -DOPTION_TARGET_MESSAGING=OFF ` | ||
| -DOPTION_TARGET_PARALLEL=OFF ` | ||
| -DOPTION_TARGET_CHOMBO2D_SOLVER=OFF ` | ||
| -DOPTION_TARGET_CHOMBO3D_SOLVER=OFF ` | ||
| -DOPTION_TARGET_SMOLDYN_SOLVER=ON ` | ||
| -DOPTION_TARGET_FV_SOLVER=ON ` | ||
| -DOPTION_TARGET_STOCHASTIC_SOLVER=ON ` | ||
| -DOPTION_TARGET_NFSIM_SOLVER=ON ` | ||
| -DOPTION_TARGET_MOVINGBOUNDARY_SOLVER=OFF ` | ||
| -DOPTION_TARGET_SUNDIALS_SOLVER=ON ` | ||
| -DOPTION_TARGET_HY3S_SOLVERS=OFF ` | ||
| .. | ||
| ``` | ||
| - `make` | ||
| - :exclamation:**Note: Remove wrongly built NFSim solver if you want build in same | ||
| - building only NFSim | ||
| - ``` | ||
| cmake -G "Unix Makefiles" ` | ||
| -DBUILD_SHARED_LIBS=OFF ` | ||
| -DCMAKE_FIND_LIBRARY_SUFFIXES=".a" ` | ||
| -DCMAKE_EXE_LINKER_FLAGS="-static" ` | ||
| -DOPTION_TARGET_MESSAGING=OFF ` | ||
| -DOPTION_TARGET_PARALLEL=OFF ` | ||
| -DOPTION_TARGET_CHOMBO2D_SOLVER=OFF ` | ||
| -DOPTION_TARGET_CHOMBO3D_SOLVER=OFF ` | ||
| -DOPTION_TARGET_SMOLDYN_SOLVER=OFF ` | ||
| -DOPTION_TARGET_FV_SOLVER=OFF ` | ||
| -DOPTION_TARGET_STOCHASTIC_SOLVER=OFF ` | ||
| -DOPTION_TARGET_NFSIM_SOLVER=ON ` | ||
| -DOPTION_TARGET_MOVINGBOUNDARY_SOLVER=OFF ` | ||
| -DOPTION_TARGET_SUNDIALS_SOLVER=OFF ` | ||
| -DOPTION_TARGET_HY3S_SOLVERS=OFF ` | ||
| .. | ||
| ``` | ||
| - `make` |