Skip to main content

Python implementations of Imaginary-time Evolution algorithms

Project description

https://github.com/linusjoonho/ipie/blob/main/logo.png

ipie stands for Intelligent Python-based Imaginary-time Evolution with a focus on simplicity and speed.

ipie inherits a lot of QMC features from pauxy.

https://github.com/linusjoonho/ipie/workflows/CI/badge.svg http://readthedocs.org/projects/ipie/badge/?version=latest https://img.shields.io/badge/License-Apache%20v2-blue.svg https://img.shields.io/badge/paper%20%28v0%29-arXiv%3A2209.04015-B31B1B

Copyright by Joonho Lee (joonholee@g.harvard.edu) Our first release paper can be found at https://pubs.acs.org/doi/10.1021/acs.jctc.2c00934

Features

ipie currently supports:

  • estimation of the ground state energy of ab-initio systems using phaseless AFQMC with support for CPUs and GPUs.

  • simple data analysis.

  • other legacy functionalities available in pauxy such as the ground state and finite-temperature energies and properties (via backpropagation) of the ab initio, UEG, Hubbard, and Hubbard-Holstein models.

Installation

Linux and Mac OS wheels are available for installation via pip

$ pip install ipie

For develpment you can instead clone the repository

$ git clone https://github.com/linusjoonho/ipie.git

and run the following in the top-level ipie directory

$ pip install -r requirements.txt
$ pip install -e .

Requirements

To build ipie with MPI support (via mpi4py) do:

$ pip install -e .[mpi]

Note that mpi4py requires a working MPI installation to be built on your machine. This it is often the trickiest dependency to setup correctly.

One of the easiest ways (if you are using pip to install ipie wheels) is via conda:

conda install openmpi

which will just install the OpenMPI library. We refer users to the mpi4py documentation for alternative ways of building mpi4py and the required MPI library.

Further requirements are listed in requirements.txt.

GPU Support

Cupy is is required when running calculations on GPUs which can be install following the instructions here .

Cuda aware MPI may be installed via conda-forge.

Running the Test Suite

ipie contains unit tests and some longer driver tests that can be run using pytest by running:

$ pytest -v

in the base of the repo. Some longer parallel tests are also run through the CI. See .github/workflows/ci.yml for more details.

https://github.com/linusjoonho/ipie/workflows/CI/badge.svg

Documentation

Documentation and tutorials are available at readthedocs.

http://readthedocs.org/projects/ipie/badge/?version=latest

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

ipie-0.7.1.tar.gz (358.1 kB view details)

Uploaded Source

Built Distribution

ipie-0.7.1-py3-none-any.whl (528.7 kB view details)

Uploaded Python 3

File details

Details for the file ipie-0.7.1.tar.gz.

File metadata

  • Download URL: ipie-0.7.1.tar.gz
  • Upload date:
  • Size: 358.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for ipie-0.7.1.tar.gz
Algorithm Hash digest
SHA256 d71d8d3347e2d6b0053c30ad49674b80d7427b5dd327a5989a74b583d8f8a6f7
MD5 02118cb00633046e8b491a8c1a9c224b
BLAKE2b-256 10d3ef5d5c34567b8913f691c4ccd8da4a98b6d595df90b6ac7a03f3eb825d6b

See more details on using hashes here.

File details

Details for the file ipie-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: ipie-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 528.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for ipie-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fb14bb673b007ade07242cdb99852c8b6ba944b75a7777ba7cc1ce1db82742e6
MD5 029f844fe36d5e7f9bf33aceeb0e51ff
BLAKE2b-256 ffdc630d0354f4a07ae9460918dde98e42909c3606522d29cfbad196bce39866

See more details on using hashes here.

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