Taped

A simple way to record the outputs of simulations.

Taped is inspired by loguru which makes logging easy: Tape makes it is to not only save the logs of simulations ran in Python, but also to save data, plots and any other useful file which you'll need to analyze the simulations' results.

To install Tape, create a python environment and use:

pip install tpd

Usage

Using Taped is easy:

from tpd import recorder

recorder.start(
    base_folder='my_computer/my_data',
    name='simulation_2'
    )
'''
    Creates a folder 'simulation_2' in the 'base_folder'
    From now on, all data, logs and plots will be saved in
        my_computer/my_data/simulation_2
'''

# all logs will be saved in a .log file
from loguru import logger
logger.info('I cant wait to check the logs later!')


# you can save data to file easily
import numpy as np
X = np.random.rand(100, 100)
recorder.add_data(X, 'my_results', fmt='npy')  # or 'mat' for matlab


# and save plots
import matplotlib.pyplot as plt

f = plt.figure()
recorder.add_figure(f, 'first plot', svg=True)
del f

# and save multiple figures at once
f1 = plt.figure()
f2 = plt.figure()

f1._save_name = 'first of two'
f2._save_name = 'second of two'
recorder.add_figures()

# finally, you can check what's saved so far
recorder.describe()

The result should look somthing like this: