Skip to content

adutoi/Qode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Qode

Qode is a python-based library for experimental quantum chemistry code.

Description

Qode is organized into modules that . . .

Features

  • think
  • of some good
  • things to put here

Usage

quickstart

Some small examples here.

full documentation

After cloning, point your browser to the file docs/html/index.html (also hosted on ReadTheDocs). See also the docs/samples/ directory.

Installation

Cloning this repo and making sure the Qode/ project directory is in your Python search path.

dependencies

Numpy and you might need to install an integrals engine unless you want to read all your integrals from disk.

There are hooks for using Psi4 as an integrals engine in a conda environment. conda create --name Psi4 psi4 -c psi4; conda activate Psi4

Some C code is dynamically compiled to shared library files and linked against, so you will need a C compile available for this. gcc is a good choice.

So far this has only been tested for python>=3.7 on *nix systems (specifically Linux/Mac).

support

Email tonydutoi@gmail.com, and I'll do what I can.

Testing and Development

testing

In the tests/ directories there will eventually be some basic tests to ensure the code is installed and working in your environment, each with some in-place instructions on what is being tested.

contributing

Just get in touch with your idea for improvement and we'll discuss.

to-do list

  • This list
  • is on
  • the to-do list.

Copyright and License

© Copyright 2012-2023 Anthony D. Dutoi (tonydutoi@gmail.com), Yuhong Liu, Boris Daniel Gutiérrez-Cortés, Marco Bauer

Library source code: GPLv3
Documentation (including this file): CC-BY-SA 4.0
See the LICENSE file in this same directory for further information.


© Copyright 2023 Anthony D. Dutoi
Creative Commons License   This documentation and its components (text, images, and code) are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License .

About

A python-based library for experimental quantum chemistry code

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published