Metadata-Version: 2.4
Name: bbprepared
Version: 2026.3.15.0
Maintainer-email: Andrew Tarzia <andrew.tarzia@gmail.com>
Project-URL: github, https://github.com/andrewtarzia/bbprepared
Project-URL: documentation, https://bbprepared.readthedocs.io
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: rdkit
Requires-Dist: stk
Requires-Dist: stko
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: charset-normalizer!=3.4.6; extra == "dev"
Requires-Dist: pytest-datadir; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-copybutton; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: furo; extra == "dev"
Requires-Dist: moldoc; extra == "dev"
Dynamic: license-file

:maintainers:
  `andrewtarzia <https://github.com/andrewtarzia/>`_
:documentation: https://bbprepared.readthedocs.io/en/latest/


============
Introduction
============

``bbprepared`` is a toolkit aimed at simplifying the
preparation of your building blocks for
`stk <https://stk.readthedocs.io/en/stable/>`_ construction and analysis.


Installation
============

To get ``bbprepared``, you can install it with pip:

.. code-block:: bash

  pip install bbprepared

Developer Setup
---------------

To develop with ``bbprepared``, you can clone the repo and use
`just <https://github.com/casey/just>`_ and `uv <https://docs.astral.sh>`_
to setup the dev environment:

.. code-block:: bash

  just setup



Examples
========

* See ``examples/`` directory for some examples.
* See ``Recipes`` for usage and the code tests include additional examples.
* See `gists <https://gist.github.com/andrewtarzia>`_ for usage.
* In particular `this tutorial <https://gist.github.com/andrewtarzia/23e7843365bad76277322e207d95e627>`_

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 <http://www.jelfs-group.org/>`_, and during my time as a developer
of `stk <https://stk.readthedocs.io/en/stable/>`_ and
`stko <https://github.com/JelfsMaterialsGroup/stko>`_ with Lukas Turcani.
