@@ -15,4 +15,55 @@ Virtual Cell ODE [virtualcell/vcell-ode](https://github.com/virtualcell/vcell-od
1515simulation libraries and protocols used to process ODEs in the Virtual Cell framework [ virtualcell/vcell] ( https://github.com/virtualcell/vcell ) ).
1616
1717## Building VCell ODE
18- * git clone https://github.com/virtualcell/vcell.git
18+ There are two ways to build VCell ODE, but both start out the same way
19+ ### Step 1: Acquire the source-code
20+ The source code can be found online at the GitHub repository.
21+ ` git clone https://github.com/virtualcell/vcell.git `
22+
23+ ### Step 2: Install Dependencies
24+ You will need to acquire a unix-style C and C++ compiler suite in order to build VCell ODE. Traditionally, this project
25+ uses CLang + Mold, but other compiler suites may work. Additionally, you'll need to install the other dependencies for
26+ VCell ODE, which can be done in one of two ways:
27+
28+ #### Method 1: Conan Toolchain (Recommended)
29+ The VCell ODE project uses the C++ dependency management system called *** conan*** to handle dependency management when
30+ building VCell ODE. We provide a number of conan-profiles that will provide conan the information need to automatically
31+ build the desired toolchain for cmake.
32+
33+ #### Method 2: Manual Dependency Installation
34+ If you'd rather manually install all the dependencies build-tools to create VCell CLI, you'll need the following:
35+ ##### Dependencies
36+ * If you want live messaging while the solver runs: ` libcurl ` (add ` -DOPTION_TARGET_MESSAGING ` to cmake call below)
37+ ##### Build Tools
38+ * ` cmake ` to perform the build configuration
39+ * ` ninja ` (or equivalent) to perform the actual build process
40+
41+ ### Step 3: Invoke the Build
42+ In a shell with conan and/or the other build tools in path, navigate to the project's root directory and
43+ run the following commands (tested in bash on unix and powershell on windows)
44+
45+ Note that if using ` conan ` , you'll need to define a profile. use ` conan profile detect --force ` to generate one automatically,
46+ or use one of the provided ones in ` <project_root>/conan-profiles ` [ link] ( https://docs.conan.io/2/reference/config_files/profiles.html )
47+ to further reading on the official ` conan ` website.
48+ #### Powershell
49+ ``` pwsh
50+ mdkir build # Must do if not using conan
51+ conan install . --output-folder build --build=missing # If building using conan's help
52+ cd build
53+ ./conanbuild.ps1 # If building using conan's help
54+ cmake -B . -S .. -G "Ninja" -DCMAKE_TOOLCHAIN_FILE="conan_toolchain.cmake" -DCMAKE_BUILD_TYPE=Release
55+ cmake --build . --config Release
56+ ```
57+
58+ ``` bash
59+ mdkir build # must do if not building conan
60+ conan install . --output-folder build --build=missing # If building using conan's help
61+ cd build
62+ ./conanbuild.sh # If building using conan's help
63+ cmake -B . -S .. -G " Ninja" -DCMAKE_TOOLCHAIN_FILE=" conan_toolchain.cmake" -DCMAKE_BUILD_TYPE=Release
64+ cmake --build . --config Release
65+ ```
66+
67+ ### Step 4: Manual user/system install
68+ Currently, VCell ODE does not have an automated installation script. You will either need to move the resulting executables
69+ in ` <project_root>/build/bin ` to an appropriate folder in path, or put said folder into path for your computer.
0 commit comments