Update documentation with new features and instructions for new blocks

SimVascular / svZeroDSolver

A C++ lumped-parameter solver for blood flow and pressure in hemodynamic networks

https://simvascular.github.io/documentation/rom_simulation.html#0d-solver

Other

7 stars 20 forks source link

Update documentation with new features and instructions for new blocks #113

Closed menon-karthik closed 4 months ago

menon-karthik commented 5 months ago

Current situation

Closes #66 We recently had a few new features implemented (or in soon-to-be-merged PRs). So I made some updates to the documentation to reflect those changes.

Release Notes

Added a new page documenting how to add new blocks.
Added a new section on contributing to the code.
Added documentation on #108
Added documentation on #109
Added short summary of available blocks (including new ones)

Documentation

This is the documentation.

Testing

Documentation builds. Did not change anything else.

Code of Conduct & Contributing Guidelines

I agree to follow the Code of Conduct and Contributing Guidelines.

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 79.25%. Comparing base (688cece) to head (db7deda).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #113 +/- ## ======================================= Coverage 79.25% 79.25% ======================================= Files 52 52 Lines 2179 2179 Branches 278 278 ======================================= Hits 1727 1727 Misses 452 452 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mrp089 commented 4 months ago

The macos-11 GitHub runner is not available anymore as of July, so I removed it.

I added a macos-latest runner (and ubuntu-latest) so we always stay up to date. However, there seems to be a problem with conda. Up to you, @menon-karthik, if you want to do this upgrade now or leave it for a later PR.

menon-karthik commented 4 months ago

The macos-11 GitHub runner is not available anymore as of July, so I removed it.

I added a macos-latest runner (and ubuntu-latest) so we always stay up to date. However, there seems to be a problem with conda. Up to you, @menon-karthik, if you want to do this upgrade now or leave it for a later PR.

I think it's a good idea to stay ahead of the curve, so let's upgrade that right away. I fixed the conda problem by using conda-incubator to find conda and add it to the path. Also, it looks like macos-12 is also going to be removed soon. I will create a new issue and PR to upgrade that just so it is recorded.