Reference#
This part of the project documentation focuses on
an information-oriented approach. Use it as a
reference for the technical implementation of the
radcad project code.
Table of Contents#
Development#
Jump to Development section for information about:
- Set up environment with Poetry
- Jupyter Notebooks with Poetry
cadCAD Compatibility#
Jump to cadCAD Compatibility to read more about:
- Migrating from cadCAD to radCAD
- cadCAD Compatibility Mode
Directory Structure#
- benchmarks/: Tests to compare execution time of cadCAD and radCAD.
- cluster/: Tests to compare execution time of cadCAD and radCAD.
- docs/: Documentation such as auto-generated docs from Python docstrings and Markdown docs
- examples/: Analysis notebooks and experiment workflow (such as configuration and execution)
- radcad/: Model software architecture (structural and configuration modules)
- tests/: Unit and integration tests for model and notebooks
Model Architecture#
In the Getting started we have introduced a very general overview of the main classes: Model, Simulation, Experiment, Engine.
Jump to Model Architecture for more details about the classes used in radCAD.
Known issues#
Plotly doesn't display in Jupyter Lab#
To install and use Plotly with Jupyter Lab, you might need NodeJS installed to build Node dependencies, unless you're using the Anaconda/Conda package manager to manage your environment. Alternatively, use Jupyter Notebook which works out the box with Plotly.
See: Plotly Documentation
You might need to install the following "lab extension":
jupyter labextension install jupyterlab-plotly@4.14.3
Windows Issues#
If you receive the following error and you use Anaconda, try: conda install -c anaconda pywin32
DLL load failed while importing win32api: The specified procedure could not be found.