Skip to content

longtailfinancial/cadCAD-tools

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cadCAD-tools

Tools for improving the cadCAD user experience. This library contains wrappers for executing simulations easily as well as tools for profiling and typing.

How to use

The best way is by looking into the example notebooks on the notebooks/ folder

Setup

Just use pip.

python -m pip install cadCAD-tools

Features

Easy execution of cadCAD models

Easy enough:

from cadCAD_tools import easy_run

df = easy_run(initial_conditions,
              params,
              partial_state_update_blocks,
              TIMESTEPS,
              SAMPLES,
              use_labels=True,
              assign_params=True,
              drop_substeps=False)

cadCAD specific types

from cadCAD_tools.types import StateVariable, Parameter, StateUpdateBlock

Profiling tools & visualizations

cadCAD-tools includes wrappers for automatically decorating the PSUBs with time measuring functions. Through the usage of metadata, it is possible to obtain a clear view of what SUBs are being more expensive.

from cadCAD_tools import profile_run

df = profile_run(initial_conditions,
              params,
              partial_state_update_blocks,
              TIMESTEPS,
              SAMPLES,
              use_labels=True,
              assign_params=True)
from cadCAD_tools.profiling.visualizations import visualize_substep_impact

visualize_substep_impact(df, relative=True)

from cadCAD_tools.profiling.visualizations import visualize_elapsed_time_per_ts

visualize_elapsed_time_per_ts(df, relative=False)

About

Tools for improving cadCAD experience

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 98.9%
  • Python 1.1%