Skip to content

Commit 38bf812

Browse files
authored
Update README.md
1 parent b78518b commit 38bf812

File tree

1 file changed

+44
-45
lines changed

1 file changed

+44
-45
lines changed

README.md

Lines changed: 44 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -7,50 +7,10 @@ Some of the main contributors are I. Vignon-Clementel, N. Wilson, J. Wan, B. Ste
77

88
The one-dimensional equations for the flow of a Newtonian, incompressible fluid in a deforming, elastic domain consist of the continuity equation, a single axial momentum balance equation, a constitutive equation, and suitable initial and boundary conditions.
99

10-
## Installation
11-
12-
### Prerequisites
13-
14-
The following software is required:
15-
16-
- Sphinx (HTML Manual)
17-
- SWIG Interface generator (Python Interface)
18-
- MPI (mpi4py is used for running parameteric simulations from python)
19-
- SuperLU_MT (if you would like to use this sparse solver)
20-
21-
### Generate makefiles with CMake
22-
23-
Out-of-source is the suggested build modality. To do this, first create a build folder (for example "OneDBin") as a sibling of the main source code folder (probably "svOneDSolver")
24-
25-
~~~
26-
mkdir svOneDSolver_build
27-
~~~
28-
29-
Change directory into svOneDSolver_build
30-
31-
~~~
32-
cd svOneDSolver_build
33-
~~~
34-
35-
Now you can use the ccmake (command line) or cmake-gui (Qt-based CMake GUI) to create the make files.
36-
For example, using ccmake from the OneDBin folder type
37-
38-
~~~
39-
ccmake ../svOneDSolver
40-
~~~
41-
42-
Configure the code until CMake will let you generate the makefiles. Press "g" (ccmake) to generate the makefiles. See below for options
43-
44-
To build the code run (within "OneDBin")
45-
46-
~~~
47-
make -j n
48-
~~~
49-
50-
where n is the number of processors you want to use to build.
10+
## Usage
11+
Usage assumes that you have built from the source as described below.
5112

5213
### Basic usage
53-
5414
There are three supported usages for the generated executable.
5515
* The quotations around the input args are optional
5616
* Input file paths can be specified as a local file name or an absolute path
@@ -73,9 +33,7 @@ Run the simulation using a JSON input file
7333
svOneDSolver -jsonInput "<jsonInputFile>.json"
7434
~~~
7535

76-
77-
### Run tests
78-
36+
### Manually run tests
7937
System and unit tests can be run using ctest and pytest commands.
8038

8139
The following assume:
@@ -124,6 +82,47 @@ pytest Tests/SystemTests --relativeExePath="../svOneDSolver_build/bin/OneDSolver
12482
```
12583
</details>
12684

85+
## Installation
86+
87+
### Prerequisites
88+
89+
The following software is required:
90+
91+
- Sphinx (HTML Manual)
92+
- SWIG Interface generator (Python Interface)
93+
- MPI (mpi4py is used for running parameteric simulations from python)
94+
- SuperLU_MT (if you would like to use this sparse solver)
95+
96+
### Generate makefiles with CMake
97+
98+
Out-of-source is the suggested build modality. To do this, first create a build folder (for example "OneDBin") as a sibling of the main source code folder (probably "svOneDSolver")
99+
100+
~~~
101+
mkdir svOneDSolver_build
102+
~~~
103+
104+
Change directory into svOneDSolver_build
105+
106+
~~~
107+
cd svOneDSolver_build
108+
~~~
109+
110+
Now you can use the ccmake (command line) or cmake-gui (Qt-based CMake GUI) to create the make files.
111+
For example, using ccmake from the OneDBin folder type
112+
113+
~~~
114+
ccmake ../svOneDSolver
115+
~~~
116+
117+
Configure the code until CMake will let you generate the makefiles. Press "g" (ccmake) to generate the makefiles. See below for options
118+
119+
To build the code run (within "OneDBin")
120+
121+
~~~
122+
make -j n
123+
~~~
124+
125+
where n is the number of processors you want to use to build.
127126

128127
### CMake Options
129128

0 commit comments

Comments
 (0)