Skip to content

Commit

Permalink
clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
menon-karthik committed Jun 26, 2024
1 parent be1718d commit db7deda
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions docs/pages/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ This is useful when continuously running the integration tests during developmen
* Alternatively, the developer can run the tests locally.
* The build tests can be run using the `pip` install and `pytest`.
* The tests for the C++ interface require the `CMake` install and can be run by building the tests in `svZeroDSolver/tests/test_interface`.
* Code formatting can be performed using the instructions in the [Formatting] section below.
* The documentation can be built following the instructions in the [Documentation] section below.
* Code formatting can be performed following the instructions in the Formatting section below.
* The documentation can be built following the instructions in the Documentation section below.
* Once all the tests are passing, the developer should open a pull request from the feature branch and link the relevant issue.

# Adding new blocks
Expand Down Expand Up @@ -119,12 +119,12 @@ a+b=c
\f]
```

### Citations
## Citations
If you want to cite a piece literature in your documentation, add
a respective BibTeX citation to `docs/references.bib` and use `\cite name_of_citation` to
cite the document.

### Drawing circuits
## Drawing circuits
As the elements of the svZeroDSolver are often represented
in the form of electrical circuits, we use [CircuiTikZ](https://ctan.org/pkg/circuitikz?lang=en)
to draw circuits in the documentation (see blocks in Block for examples).
Expand All @@ -137,7 +137,7 @@ To start a CircuitTikZ drawing use the following command:
\f]
```

### Build
## Build
The documentation is automatically built in the GitHub CI/CD and published
on GitHub pages. If you want to build the documentation locally, you can use:

Expand All @@ -149,7 +149,7 @@ You can then view the documentation locally in your browser by opening `docs/bui
If you do not have Doxygen install you can do that with `brew install doxygen`
on macOS or with `sudo apt-get install doxygen` on Linux.

## Profiling
# Profiling

Profiling helps to easily identify bottlenecks in the code. A profiling report
lists the executation time spend on certain parts of the code. If you experience
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ cmake --build .
If you are a developer and want to contribute to svZeroDSolver, you can find
more helpful information in our [Developer Guide](@ref developer_guide).

# svZeroDSolver
# svZeroDSolver - Quick Guide

svZeroDSolver can be used to run zero-dimensional (0D) cardiovascular
simulations based on a given configuration.
Expand Down Expand Up @@ -336,7 +336,7 @@ The above table describes the most commonly used boundary conditions. In additio

Note that the `FLOW` and `PRESSURE` boundary conditions accept mathematical expressions in `bc_values`. For an example where values of the boundary condition are specified as a function of time, see `svZeroDSolver/tests/cases/pulsatileFlow_R_RCR.json`. For an example with a mathematical expression for the boundary condition, see `svZeroDSolver/tests/cases/timeDep_Flow.json`.

# svZeroDCalibrator
# svZeroDCalibrator - Quick Guide

svZeroDCalibrator can be used to calibrate cardiovascular 0D models (i.e. infer optimal
parameters for the 0D elements) based on a given transient result (i.e. from a
Expand Down

0 comments on commit db7deda

Please sign in to comment.