Welcome to YASF

YASF is a Python implementation of the Celes framework (based on Matlab) and extends its functionality by providing optical parameters, similar to MSTM (based on Fortran).

Install

pip

pip install yasfpy

Sadly yasf was already taken, so the package is called yasfpy for the Python version and can be found on pypi.

conda

To run code on the GPU, the cudetoolkit is needed. This can be installed using a provided package by nvidia, or by using the conda package as described by the numba docs. The repository provides a yaml environment file. To spin an environment up (and update it later on), use:

conda env create -f yasf-env.yml # install
conda env update -f yasf-env.yml # update the environment (deactivate and activate again for changes to apply)