Skip to main content

No project description provided

Project description

maintainers:

lukasturcani, andrewtarzia

documentation:

https://stk.readthedocs.io

discord:

https://discord.gg/zbCUzuxe2B

docs/source/_static/stk.png
https://github.com/lukasturcani/stk/workflows/tests/badge.svg?branch=master https://readthedocs.org/projects/stk/badge/?version=latest

Overview

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.

Installation

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

Developer Setup

  1. Install just.

  2. In a new virtual environment run:

just dev
  1. Setup the MongoDB container (make sure docker is installed):

just mongo
  1. Run code checks:

just check

How To Cite

If you use stk please cite

https://github.com/lukasturcani/stk

and

https://aip.scitation.org/doi/10.1063/5.0049708

Publications

about stk

using stk

Acknowledgements

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stk-2024.3.3.0.tar.gz (1.0 MB view hashes)

Uploaded source

Built Distribution

stk-2024.3.3.0-py3-none-any.whl (388.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page