Skip to content

MRChemSoft/vampyr-1

 
 

Repository files navigation

VAMPyR logo

DOI License Build and test VAMPyR codecov Binder

The Very Accurate Multiresolution Python Routines (VAMPyR) package is a high level Python interface to the MRCPP code.

Installation

From source

To build VAMPyR from source with OpenMP parallelization using CMake:

$ git clone https://github.com/MRChemSoft/vampyr.git
$ cd vampyr
$ mkdir build
$ cd build
$ cmake ..
$ make

To use the VAMPyR module you need to add it to your $PYTHONPATH:

$ export PYTHONPATH=<path-to-vampyr>/build/lib/python<version>/site-packages:$PYTHONPATH

Using pip

To build VAMPyR from source with OpenMP parallelization using pip, here in a virtual environment called myenv:

$ git clone https://github.com/MRChemSoft/vampyr.git
$ cd vampyr
$ virtualenv myenv
$ source myenv/bin/activate
$ python -m pip install .

The VAMPyR module is now available whenever you have activated the myenv environment.

Using Conda

Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

To install VAMPyR in a Conda environment myenv:

$ conda create -n myenv
$ conda activate myenv
$ conda install -c conda-forge vampyr               # latest version (OpenMP)
$ conda install -c conda-forge vampyr=0.1.0rc0      # tagged version (OpenMP)

To list all available versions:

$ conda search -c conda-forge vampyr

Note that the conda-forge package is always built with OpenMP support enabled in the MRCPP backend.

The VAMPyR module is now available whenever you have activated the myenv environment.

About

Very Accurate Multiresolution Python Routines

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 46.1%
  • C++ 39.3%
  • CMake 13.7%
  • Other 0.9%