Skip to content

Commit 1b273b0

Browse files
committed
Update the REAME file
1 parent 5ea513b commit 1b273b0

File tree

1 file changed

+58
-7
lines changed

1 file changed

+58
-7
lines changed

README.md

Lines changed: 58 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![Python package](https://github.com/yafshar/xsum/workflows/Python%20package/badge.svg)](https://github.com/yafshar/xsum/actions)
55
[![Windows Build status](https://ci.appveyor.com/api/projects/status/kd1sksf5t3kdsibn/branch/master?svg=true)](https://ci.appveyor.com/project/yafshar/xsum/branch/master)
66
[![PyPI](https://img.shields.io/pypi/v/xsum.svg)](https://pypi.python.org/pypi/xsum)
7+
[![Anaconda-Server Badge](https://img.shields.io/conda/vn/conda-forge/xsum.svg)](https://anaconda.org/conda-forge/xsum)
78
[![License](https://img.shields.io/badge/license-LGPL--v2-blue)](LICENSE)
89

910
In applications like optimization or finding the sample mean of data, it is
@@ -484,32 +485,82 @@ Rank = 0, sum = 0.95600000000000007194, sum 1 = 0.95599999999998419575, sum
484485
### Python
485486

486487
The provided Python bindings provide the *exact summation* interface in a
487-
Python code. You need Python 3.6 or later to run `xsum`. You can have multiple
488-
Python versions (2.x and 3.x) installed on the same system without problems.
488+
Python code.
489+
490+
### Python requirements
491+
492+
You need Python 3.6 or later to run `xsum`. You can have multiple Python
493+
versions (2.x and 3.x) installed on the same system without problems.
489494

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

499+
### Using pip
500+
494501
**pip** is the most popular tool for installing Python packages, and the one
495-
included with modern versions of Python. `pip` currently supports cloning over
496-
`git`.
502+
included with modern versions of Python.
497503

498504
`xsum` can be installed with `pip`:
499505

500506
```sh
501-
pip install git+https://github.com/yafshar/xsum.git
507+
pip install xsum
502508
```
503509

504510
**Note:**
505511

506512
Depending on your Python installation, you may need to use `pip3` instead of
507-
`pip`, or you may have to run `pip` like this:
513+
`pip`.
514+
515+
```sh
516+
pip3 install xsum
517+
```
518+
519+
Depending on your configuration, you may have to run `pip` like this:
520+
521+
```sh
522+
python3 -m pip install xsum
523+
```
524+
525+
### Using pip (GIT Support)
526+
527+
`pip` currently supports cloning over `git`
528+
529+
```sh
530+
pip install git+https://github.com/yafshar/xsum.git
531+
```
532+
533+
For more information and examples, see the
534+
[pip install](https://pip.pypa.io/en/stable/reference/pip_install/#id18)
535+
reference.
536+
537+
### Using conda
538+
539+
**conda** is the package management tool for Anaconda Python installations.
540+
541+
Installing `xsum` from the `conda-forge` channel can be achieved by
542+
adding `conda-forge` to your channels with:
508543

509544
```sh
510-
python3 -m pip install git+https://github.com/yafshar/xsum.git
545+
conda config --add channels conda-forge
511546
```
512547

548+
Once the `conda-forge` channel has been enabled, `xsum` can be
549+
installed with:
550+
551+
```sh
552+
conda install xsum
553+
```
554+
555+
It is possible to list all of the versions of `xsum` available on your platform
556+
with:
557+
558+
```sh
559+
conda search xsum --channel conda-forge
560+
```
561+
562+
### Python examples
563+
513564
```py
514565
from xsum import *
515566
import numpy as np

0 commit comments

Comments
 (0)