Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation guide in README.md #204

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
[![pytest](https://github.com/theochem/gbasis/actions/workflows/pytest.yaml/badge.svg?branch=master)](https://github.com/theochem/gbasis/actions/workflows/pytest.yaml)
[![codecov](https://codecov.io/gh/theochem/gbasis/graph/badge.svg?token=QPUfAWj7vf)](https://codecov.io/gh/theochem/gbasis)
[![PyPI](https://img.shields.io/pypi/v/qc-gbasis.svg)](https://pypi.python.org/pypi/qc-gbasis/)
![Version](https://img.shields.io/pypi/pyversions/qc-gbasis.svg)
![License](https://img.shields.io/github/license/theochem/gbasis)
[![documentation](https://github.com/theochem/gbasis/actions/workflows/build_website.yaml/badge.svg?branch=master)](https://github.com/theochem/gbasis/actions/workflows/build_website.yaml)

Expand Down Expand Up @@ -34,7 +33,13 @@ Please use the following citation in any publication using `gbasis` library:

## Installation

[See the website for installation instructions.](https://gbasis.qcdevs.org/installation.html)
To install the latest release of `qc-gbasis`, run as follows:

```bash
python -m pip install qc-gbasis
```

See https://gbasis.qcdevs.org/installation.html for full details.

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion website/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ launch_buttons:
thebe : true
colab_url: "https://colab.research.google.com"

copyright: "2022-2023"
copyright: "2022-2024"

html:
use_issues_button: true
Expand Down
38 changes: 9 additions & 29 deletions website/installation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,39 +18,19 @@
"\n",
"The following dependencies are required to run GBasis properly,\n",
"\n",
"* Python >= 3.6: http://www.python.org/ \n",
"* Numpy >= 1.10: http://www.numpy.org/\n",
"* SciPy >= 1.0, <1=.10.1 : http://www.scipy.org/\n",
"* Python >= 3.9: http://www.python.org/\n",
"* Numpy: http://www.numpy.org/\n",
" - numpy >=1.22, <2.0.0 for Windows\n",
" - numpy >=1.22 for Linux\n",
"* SciPy >= 1.11.1: http://www.scipy.org/\n",
"* importlib_resources: https://pypi.org/project/importlib_resources/\n",
"* sympy: https://www.sympy.org/\n",
"* PyTest >= 5.3.4: https://docs.pytest.org/\n",
"* PyTest-Cov >= 2.8.0: https://pypi.org/project/pytest-cov\n",
"\n",
"Normally, you don’t need to install these dependencies manually. They will be installed automatically when you follow the instructions below.\n",
"\n",
"\n",
"## Installation with Ana- or Miniconda:\n",
"\n",
"1. To install GBasis using the conda package management system, install [miniconda](https://conda.io/miniconda.html) or [anaconda](https://www.anaconda.com/download) first, and then:\n",
"\n",
"```bash\n",
"# Activate your main conda environment if it is not loaded in your .bashrc.\n",
"# E.g. run the following if you have miniconda installed in e.g. ~/miniconda3\n",
"source ~/miniconda3/bin/activate\n",
"\n",
"# Create a horton3 conda environment. (optional, recommended)\n",
"conda create -n horton3\n",
"source activate horton3\n",
"\n",
"# Install the stable release.\n",
"conda install gbasis -c theochem\n",
"\n",
"# Unstable releases\n",
"# (Only do this if you understand the implications.)\n",
"# Install the testing release. (beta)\n",
"conda install -c theochem/label/test gbasis\n",
"# Install the development release. (alpha)\n",
"conda install -c theochem/label/dev gbasis\n",
"```\n",
"\n",
"## Installation with Pip\n",
"\n",
"1. You can work in a [virtual environment](https://docs.python.org/3/tutorial/venv.html):\n",
Expand All @@ -64,12 +44,12 @@
"source ~/horton3/bin/activate\n",
"\n",
"# Install the stable release in the venv horton3.\n",
"pip3 install gbasis\n",
"pip3 install qc-gbasis\n",
"# alternative: python3 -m pip install gbasis\n",
"\n",
"# For developers, install a pre-release (alpha or beta).\n",
"# (Only do this if you understand the implications.)\n",
"pip3 install --pre gbasis\n",
"pip3 install --pre qc-gbasis\n",
"# alternative: python3 -m pip install --pre gbasis\n",
"```\n",
"\n",
Expand Down
Loading