To Do

List of things that should be added to the documentation.

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/adapt/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/circadapt/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/components/cavity/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/components/connector/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/components/global_functions/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/components/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/components/node/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/components/patch/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/components/solver/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/components/wall/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/error/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/matlab/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/model/benchmark/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/model/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/model/vanosta2023/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/model/vanosta2024/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/plot/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/plot/triseg/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/settings/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/smart_components/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/smart_components_circulation/index.rst, line 1.)

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/circadapt/smart_components_heart/index.rst, line 1.)

Todo

Improve autoapi layout

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\autoapi/index.rst, line 4.)

Todo

The CircAdapt framework currently in beta phase. We are working on documentation, verification, and validation of the framework. If you find any bug or issue, don’t hesitate to contact us.

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\index.rst, line 4.)

Todo

Improve figure, make all items clickable (Now only Chamber is)

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/components.rst, line 15.)

Todo

Explain how to build from scratch and how to link walls

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/components/global/pressure_flow_control.rst, line 110.)

Todo

Explain how to build from scratch and how to link walls

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/components/global/timings.rst, line 31.)

Todo

derive wave impedance.

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/components/node/cavity/Chamber.rst, line 42.)

Todo

  • Explain the solving strategy.

  • Present the initial parameterization.

  • Discuss the model verification process.

  • Explain adaptation protocol

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/models/VanOsta2024.rst, line 112.)

Todo

Update overview of the framework and its solving strategy.

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/models/VanOsta2024.rst, line 121.)

Todo

Explain how to create a custom model class

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/models/build_model/build_class.rst, line 6.)

Todo

Explain how to create a custom model

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/models/build_model/build_model.rst, line 6.)

Todo

Explain how to create a reference model state for a custom model class

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/models/build_model/parameterize_class.rst, line 6.)

Todo

Explain solver, explain parameters of the solver

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/solvers/adams_bashforth.rst, line 4.)

Todo

Explain solver, explain parameters of the solver

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/solvers/adams_moulton.rst, line 5.)

Todo

Explain solver, explain parameters of the solver

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/solvers/backward_differential.rst, line 4.)

Todo

Explain solver, explain parameters of the solver

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/solvers/backward_euler.rst, line 4.)

Todo

Explain solver, explain parameters of the solver

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/solvers/forward_euler.rst, line 4.)

Todo

Explain solver, explain parameters of the solver

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/solvers/runge_kutta4.rst, line 4.)

Todo

Explain solver, explain parameters of the solver

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/solvers/trapezoidal_rule.rst, line 4.)

Todo

Add more tutorials

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/tutorials.rst, line 6.)

Todo

Make One-Ventricle Circulation figure

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/tutorials/models/simple_circulation.rst, line 6.)

Todo

Make One-Ventricle Circulation figure

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/tutorials/models/simple_open_circulation.rst, line 6.)

Todo

Make Preload Afterload methods figure

(The original entry is located in C:\Users\n.vanosta\GitHub\pyCircAdapt\docs\source\userguide/tutorials/patch/preload_afterload.rst, line 11.)