maintainers: | lukasturcani, andrewtarzia |
---|---|
documentation: | https://stk.readthedocs.io |
discord: | https://discord.gg/zbCUzuxe2B |
stk
is a Python library which allows construction and
manipulation of complex molecules, as well as automatic
molecular design, and the creation of molecular, and molecular
property, databases. The documentation of stk
is available on
https://stk.readthedocs.io and the project's Discord server can be
joined through https://discord.gg/zbCUzuxe2B.
To get stk
, you can install it with pip:
pip install stk
If you would like to get updated when a new release of stk
comes
out, which happens pretty regularly, click on the watch
button on
the top right corner of the GitHub page. Then select Releases only
from the dropdown menu.
You can see the latest releases here:
https://github.com/lukasturcani/stk/releases
There will be a corresponding release on pip
for each release
on GitHub, and you can update your stk
with:
pip install stk --upgrade
- Install just.
- In a new virtual environment run:
just dev
- Setup the MongoDB container (make sure
docker
is installed):
just mongo
- Run code checks:
just check
If you use stk
please cite
https://github.com/lukasturcani/stk
and
https://aip.scitation.org/doi/10.1063/5.0049708
- Describing metal-organic cage usage: Unlocking the computational design of metal–organic cages
- (Out of date) stk: A Python Toolkit for Supramolecular Assembly | chemrxiv
- Using stk for constructing larger numbers of coarse-grained models: Systematic exploration of accessible topologies of cage molecules via minimalistic models
- A High-Throughput Screening Approach for the Optoelectronic Properties of Conjugated Polymers | chemrxiv
I began developing this code when I was working in the Jelfs group, http://www.jelfs-group.org/, whose members often provide me with very valuable feedback, which I gratefully acknowledge.