0. Thermal Model Wiki

Welcome to the Thermal Model wiki, here you will find a description of the available functions and features.

This repository serves two primary functions.

1. To help the user create a thermal model of a cryogenic system using a Python based GUI.
2. Allow the user to manipulate and explore the thermal model in Python using built-in functions and classes.

This tool can be installed either as a python package, or cloned as a GitHub repository.

Installation

pip install git+https://github.com/henry-e-n/python_thermal_model.git

Dependencies

The package should automatically install other python package dependencies during install. The thermal model calculation also require the use of the CMB-S4 Cryogenic Material Repository data. This must be manually cloned to the local machine. On the first run of functions in this thermal model, python will prompt you for the local path to the CMR.

https://github.com/CMB-S4/Cryogenic_Material_Properties.git

Streamlit GUI

To start the Streamlit GUI, run the following code in a python file.

from thermal_model.gui_init import init_gui
init_gui()

Alternatively, if you have cloned the repository, you can start the GUI via

streamlit run <PATH_TO_THERMAL_MODEL>/thermal_model_gui.py

Note: The GUI opens to a local IP. Thus, this is not well suited for running via an SSH shell or otherwise.