Introduction¶
bbprepared is a toolkit aimed at simplifying the
preparation of your building blocks for
stk construction and analysis.
Installation¶
To get bbprepared, you can install it with pip. However, there is a
distinction based on if you want the “lite” versions of stk and stko.
This command will just give you bbprepared, but will not provide all the
dependancies:
pip install bbprepared
You can then add stk/stko:
pip install stk stko
Or stk-lite/stko-lite:
pip install stk-lite stko-lite
You can do this in one step as:
pip install "bbprepared[full]" # For stk/stko
pip install "bbprepared[lite]" # For stk-lite/stko-lite
Warning
You should not mix stk/stko and stk-lite/stko-lite and
bbprepared will raise an error if you do.
Fix: “pip uninstall -y stk stk-lite stko stko-lite” then “pip install ‘bbprepared[full]’” (or ‘bbprepared[lite]’)
Developer Setup¶
To develop with bbprepared, you can clone the repo and use
just and uv
to setup the dev environment with stk-lite/stko-lite:
just setup
Examples¶
See Recipes for usage and the code tests include additional examples.
See gists for usage.
In particular this tutorial
How To Cite¶
If you use bbprepared please mention the URL
Or use the citation file.
Acknowledgements¶
Funded by the European Union - Next Generation EU, Mission 4 Component 1 CUP E13C22002930006.
This work is a mixture of codes developed throughout my postdoc in the Jelfs Group, and during my time as a developer of stk and stko with Lukas Turcani.