Skip to content

andrewtarzia/bbprepared

Repository files navigation

maintainers:andrewtarzia
documentation:https://bbprepared.readthedocs.io/en/latest/

Introduction

bbprepared or bbprep 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:

pip install bbprepared

Developer Setup

To develop with bbprepared, you can clone the repo and use just and uv to setup the dev environment:

just setup

Examples

  • See examples/ directory for some 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

https://github.com/andrewtarzia/bbprepared

Or cite using thr CITATION.cff 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.

About

Prepare your building blocks for stk construction and analysis

Topics

Resources

License

Stars

Watchers

Forks