Skip to content

setup.py install is a bad idea #5

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.

Sign up for GitHub

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

Open
jamesmyatt wants to merge 1 commit into
base: master
Choose a base branch
from
Open

setup.py install is a bad idea #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Pycorels

[![Build Status](https://travis-ci.org/fingoldin/pycorels.svg?branch=master)](https://travis-ci.org/fingoldin/pycorels)
[![Documentation Status](https://readthedocs.org/projects/pycorels/badge/?version=latest)](https://pycorels.readthedocs.io/en/latest/?badge=latest)

Welcome to the python binding of the Certifiably Optimal RulE ListS (CORELS) algorithm!
Welcome to the Python binding of the Certifiably Optimal RulE ListS (CORELS) algorithm!

## Overview

Expand All @@ -25,7 +26,7 @@ GMP (GNU Multiple Precision library) is not required, but it is *highly recommen
CORELS exists on PyPI, and can be downloaded with
`pip install corels`

To install from this repo, simply run `pip install .` or `python setup.py install` from the `corels/` directory.
To install from this repo, simply run `pip install .` from the `corels/` directory.

Here are some detailed examples of how to install all the dependencies needed, followed by corels itself:

Expand All @@ -47,12 +48,15 @@ pip install corels
```

#### Windows

Note: Python 2 is currently NOT supported on Windows.

```
pip install corels
```

#### Troubleshooting

- If you come across an error saying Python version >=3.5 is required, try running `pip install numpy` before again running `pip install corels`.
- If `pip` does not successfully install corels, try using `pip3`

Expand Down Expand Up @@ -110,6 +114,5 @@ print(C.predict(X))

More examples are in the `examples/` directory


### Questions?
Email the maintainer at: vassilioskaxiras@gmail.com