Skip to main content

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

Metadata

Release files for basisopt 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for basisopt 1.0.1
File Size Uploaded Provenance Actions
basisopt-1.0.1.tar.gz 54.7 kB Without provenance Details for basisopt-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for basisopt 1.0.1
File Interpreter ABI Platform Actions
basisopt-1.0.1-py3-none-any.whl Python 3 none any Details for basisopt-1.0.1-py3-none-any.whl

Total release size: 125.1 kB

Release files / basisopt-1.0.1.tar.gz

Download URL basisopt-1.0.1.tar.gz
Size 54.7 kB
Tags Source
SHA-256 checksum
How to use checksums
ad7478195db325d9276a9c4e13cb8f842a3330c1e909de2ea6b111a10f27fc6e
BLAKE2b-256 checksum
How to use checksums
f6b5657f0253271b3f0454252b9a3b612cf8704aa736b7d5d0470ccab9d7ecd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.9.13 Darwin/24.4.0

Release files / basisopt-1.0.1-py3-none-any.whl

Download URL basisopt-1.0.1-py3-none-any.whl
Size 70.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ca1afc79c035ba1cff12a78591b3b1bd36f3638e595f70b232ffd4e3f9dd78a4
BLAKE2b-256 checksum
How to use checksums
876858cf9f99fd6fddfe5da21627d11498d175d95aa65ecaf2e5726931b29c05
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.9.13 Darwin/24.4.0

Security for basisopt 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page