Skip to content

Commit

Permalink
Merge pull request #223 from timcallow/remove_libxc_from_reqs
Browse files Browse the repository at this point in the history
Remove pylibxc url from requirements as unsupported by PyPI
  • Loading branch information
timcallow authored Nov 9, 2023
2 parents cd204de + 8cde89f commit e414f44
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 10 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,15 @@ This repository is structured as follows:

## Installation

The latest stable release of `atoMEC` can be installed via `pip`:
The latest stable release of `atoMEC` can be installed via `pip`. It is first necessary to install the `libxc` package from a tarball source, because it currently has no official wheels distribution on PyPI. This step takes some time.

`pip install atoMEC`
```sh
$ pip install https://gitlab.com/libxc/libxc/-/archive/6.2.2/libxc-6.2.2.tar.gz
$ pip install atoMEC
```

Note that atoMEC does not (yet) support Windows installation (please see the section below on supported operating systems).

The installation takes some time due to the dependence on `pylibxc`, which currently has no official wheels distribution on PyPI.

Read on for instructions on how to install `atoMEC` from source, using the recommended `pipenv` installation route.

### Installation via `pipenv`
Expand All @@ -43,7 +44,7 @@ First, clone the atoMEC repository and ``cd`` into the main directory.

* It is recommended to install atoMEC inside a virtual environment. Below, we detail how to achive this with [pipenv](https://pypi.org/project/pipenv/).

This route is recommended because `pipenv` automatically creates a virtual environment and manages dependencies.
This route is recommended because `pipenv` automatically creates a virtual environment and manages dependencies. Note that `pyblibxc` is automatically installed in this case, so there is no need to install it separately.

1. First, install `pipenv` if it is not already installed, for example via `pip install pipenv` (or see [pipenv](https://pypi.org/project/pipenv/) for installation instructions)
2. Next, install `atoMEC`'s dependencies with `pipenv install` (use `--dev` option to install the test dependencies in the same environment)
Expand Down
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ scipy>=1.6.3
mendeleev>=0.7.0
tabulate>=0.8.9
joblib>=1.0.1
https://gitlab.com/libxc/libxc/-/archive/6.2.2/libxc-6.2.2.tar.gz
5 changes: 1 addition & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,7 @@
url="https://github.com/atomec-project/atoMEC",
license=license,
packages=find_packages(exclude=("tests", "docs", "examples")),
install_requires=open("requirements.txt").read().splitlines()[:-1],
dependency_links=[
"https://gitlab.com/libxc/libxc/-/archive/6.2.2/libxc-6.2.2.tar.gz",
],
install_requires=open("requirements.txt").read().splitlines(),
extras_require=extras,
python_requires=">=3.6",
)

0 comments on commit e414f44

Please sign in to comment.