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 In its current form, the package is not Debian based. This means that installing via regular pip may throw an error as it is not recommended to install a non-Debian package system-wide as it may interfere with other installs and the OS. This is remedied by installing in a conda environment or virtual environment.

To install in a conda environment you must first install pip within that conda environment.

conda install pip

Then, install the package using.

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

Execution

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
# or
python gui_init.py

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

On the first run on a new install, the streamlit gui will fail to load. You must provide the local path to the CMR after the prompt in the terminal.

Tutorial A short tutorial of the package and repository can be found in the jupyter notebook on the home directory at Thermal_Model_Tutorial.ipynb.

Logging If the code encounters a non-fatal error it will log a complaint to the log file, accessible on one of the GUI pages. This is designed to help the user troubleshoot common issues.