Skip to content

Commit

Permalink
Update installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mjwen committed Dec 17, 2023
1 parent 7e1c0e0 commit eeff93c
Showing 1 changed file with 12 additions and 71 deletions.
83 changes: 12 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,90 +9,31 @@ kimpy is a Python interface to the [KIM API](https://openkim.org/kim-api).

## Installing kimpy

### Requirements
`kimpy` requires [KIM AIP](https://openkim.org/kim-api/) and `Python 3.7` or later.

- KIM API 2 package

To install `kimpy`, you need [KIM API](https://openkim.org/kim-api). The
easiest option for obtaining the KIM API is to install the `kim-api`
pre-compiled binary package for your preferred operating system or package
manager. See
[Obtaining KIM Models](https://openkim.org/doc/usage/obtaining-models) for
instructions to install the KIM API and the models from OpenKIM on your system.

You can
[install](https://openkim.org/doc/usage/obtaining-models#installing_api)
the KIM API from source.

- Python 3.6 or later

You need Python 3.6 or later to run `kimpy`. You can have multiple
Python versions (2.x and 3.x) installed on the same system without problems.

To install Python 3 for different Linux flavors, macOS and Windows, packages
are available at\
[https://www.python.org/getit/](https://www.python.org/getit/)

### Using pip

**pip** is the most popular tool for installing Python packages, and the one
included with modern versions of Python.

`kimpy` can be installed with `pip`:

```sh
pip install kimpy
```

**Note:**

Depending on your Python installation, you may need to use `pip3` instead of
`pip`.

```sh
pip3 install kimpy
```

Depending on your configuration, you may have to run `pip` like this:

```sh
python3 -m pip install kimpy
```

### Using pip (GIT Support)
### Using conda

`pip` currently supports cloning over `git`
The recommended (and the easiest) way to install `kimpy` is to use the conda package manager to install both the KIM API and kimpy from the conda-forge channel.

```sh
pip install git+https://github.com/openkim/kimpy.git
conda install -c conda-forge kim-api kimpy
```

For more information and examples, see the
[pip install](https://pip.pypa.io/en/stable/reference/pip_install/#id18)
reference.

### Using conda

**conda** is the package management tool for Anaconda Python installations.
### Using pip

Installing `kimpy` from the `conda-forge` channel can be achieved by adding
`conda-forge` to your channels with:
This requires that the KIM API alreay be installed on your system. See the KIM-API [docs](https://openkim.org/kim-api/) for instructions on how to do this.

```sh
conda config --add channels conda-forge
pip install kimpy
```

Once the `conda-forge` channel has been enabled, `kimpy` can be installed with:

```sh
conda install kimpy
```
### From source

It is possible to list all of the versions of `kimpy` available on your
platform with:
This also requires that the KIM API alreay be installed on your system. See above.

```sh
conda search kimpy --channel conda-forge
git clone https://github.com/openkim/kimpy.git
pip install -e ./kimpy
```

## Example
Expand Down Expand Up @@ -184,7 +125,7 @@ For exampe:
## Copyright
Copyright (c) 2017-2021, Regents of the University of Minnesota.\
Copyright (c) 2017-2023, Regents of the University of Minnesota.\
All Rights Reserved
## Contributing
Expand Down

0 comments on commit eeff93c

Please sign in to comment.