Quickstart
##########

We have two quickstarts, one for the GUI module, and one for the python API.

Once installed, let's use the example data to perform a Kramers Kronig transform.


`kkcalc` is an object-oriented, typed library. The class structure is depicted below. Of note are the `asf` (atomic scattering factor) and `asp_db_extended` (atomic scattering polynomial database) classes, from which data loading and most Kramers-Kronig operations can be performed.

![Architecture graphic of the class structure in KKCalc](https://docs.google.com/drawings/d/1Py6hnj8KXS7-dePQF1435XrBfsZQHaX1XQZ-ol2J7rA/export/png)

If you are keen to include `kkcalc` into your own `python` scripts, use a modern code editor that can intepret docstrings, such as VSCode or PyCharm to get hints as you code.