Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 923 Bytes

installation.md

File metadata and controls

40 lines (27 loc) · 923 Bytes
Raw

Installation

A number of different methods can be used to run the CatLearn code.

Requirements

  • ase
  • h5py
  • networkx
  • numpy
  • pandas
  • scikit-learn
  • scipy
  • tqdm

Installation using pip

The easiest way to install CatLearn is with:

$ pip install catlearn

This will automatically install the code as well as the dependencies.

Installation from source

To get the most up-to-date development version of the code, you can clone the git repository to a local directory with:

$ git clone https://github.com/SUNCAT-Center/CatLearn.git

And then put the <install_dir>/ into your $PYTHONPATH environment variable. If you are using Windows, there is some advice on how to do that here.

Be sure to install dependencies in with:

$ pip install -r requirements.txt