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\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\autoapi\circadapt\_wildcards\index.rst, line 1.)

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\autoapi\circadapt\model\ep28\index.rst, line 1.)

Todo

Improve autoapi module

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

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\autoapi\circadapt\model\walmsley2015\index.rst, line 1.)

Todo

Improve autoapi module

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

Todo

Improve autoapi module

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

Todo

Improve autoapi module

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\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\OneDrive\Documents\GitHub\CircAdapt\python3\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\OneDrive\Documents\GitHub\CircAdapt\python3\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.

Check the release page for a timeframe of new to be implemented modules.

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

Todo

Create a nice overview of all components. Explain the inheritance.

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\userguide\components.rst, line 4.)

Todo

The CircAdapt framework is not yet available on pip. Download the latest whl file from github (https://github.com/CircAdapt/CircAdapt/releases) and use the line :bash:`pip install <path_to_whl>` instead of the lines below.

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\userguide\installation.rst, line 9.)

Todo

Create a visualization of VanOsta2022

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\userguide\models\vanosta2022.rst, line 4.)

Todo

Update overview of the framework and its solving strategy.

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\userguide\quickstart.rst, line 6.)

Todo

Add solvers

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\userguide\solvers\index.rst, line 4.)

Todo

Add more tutorials

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\userguide\tutorials.rst, line 4.)

Todo

Make Preload Afterload methods figure

(The original entry is located in C:\Users\n.vanosta\OneDrive\Documents\GitHub\CircAdapt\python3\docs\source\userguide\tutorials\patch\preload_afterload.rst, line 10.)