Skip to main content

Automatic basis set optimization for quantum chemistry

Project description

BasisOpt

Build Status codecov Documentation Status Code Quality

BasisOpt is a python library for the optimization of Gaussian basis sets as used in most quantum chemistry packages. It is currently under development, but should be reasonably stable.

Installation

The library is pip installable:

pip install basisopt

To install a development version instead, clone this repo locally, change to the folder, and use poetry. This will cleanly create a virtual environment for the project, that will ensure any changes are publishable.

poetry install -v 

You can then start an interactive shell or run a script using

poetry run [python3 or script.py]

This is local to the directory, and will not make BasisOpt available elsewhere. You can alternatively create a fresh conda env or pyenv and in the top directory run

 pip install -e .

However, if you intend to submit a PR for your change, please test building with poetry first.

Contributing

Contributions are welcomed, either in the form of raising issues or pull requests on this repo. Please take a look at the Code of Conduct before interacting, which includes instructions for reporting any violations.

Coming soon(ish)

  • Standard optimization strategies (PCSeg and correlation-consistent)

Documentation

For dependencies, detailed installation instructions, and a guide to getting started, please refer to the main documentation here.

Examples

There are working examples in the examples folder, and these are (or will be) documented in the documentation.

Acknowledging usage

If you use this library in your program and find it helpful, that's great! Any feedback would be much appreciated. If you publish results using this library, please consider citing the following paper detailing the implementation:

ChemRxiv preprint

Project details


Download files

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

Source Distribution

basisopt-1.0.1.tar.gz (54.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

basisopt-1.0.1-py3-none-any.whl (70.4 kB view details)

Uploaded Python 3

File details

Details for the file basisopt-1.0.1.tar.gz.

File metadata

  • Download URL: basisopt-1.0.1.tar.gz
  • Upload date:
  • Size: 54.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.9.13 Darwin/24.4.0

File hashes

Hashes for basisopt-1.0.1.tar.gz
Algorithm Hash digest
SHA256 ad7478195db325d9276a9c4e13cb8f842a3330c1e909de2ea6b111a10f27fc6e
MD5 f9233797414beb71868f043e067fed50
BLAKE2b-256 f6b5657f0253271b3f0454252b9a3b612cf8704aa736b7d5d0470ccab9d7ecd4

See more details on using hashes here.

File details

Details for the file basisopt-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: basisopt-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 70.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.9.13 Darwin/24.4.0

File hashes

Hashes for basisopt-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ca1afc79c035ba1cff12a78591b3b1bd36f3638e595f70b232ffd4e3f9dd78a4
MD5 8fb30c62c508fe30e704557133e8bac6
BLAKE2b-256 876858cf9f99fd6fddfe5da21627d11498d175d95aa65ecaf2e5726931b29c05

See more details on using hashes here.

Supported by

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