Skip to content

Commit 0dec1b3

Browse files
committed
touch ups to readme
1 parent 5c1fb52 commit 0dec1b3

2 files changed

Lines changed: 2 additions & 14 deletions

File tree

README.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,6 @@ PyNumDiff requires common packages like `numpy`, `scipy`, and `matplotlib`. For
102102
In addition, it also requires certain additional packages for select functions, though these are not required for a successful install of PyNumDiff:
103103
- Total Variation Regularization methods: [`cvxpy`](http://www.cvxpy.org/install/index.html)
104104
- `pytest` for unittests
105-
- `pylint` for PEP8 style check
106-
107-
When using `cvxpy`, our default solver is set to be `MOSEK` (highly recommended), you would need to download their
108-
free academic license from their [website](https://www.mosek.com/products/academic-licenses/). Otherwise, you can also
109-
use other solvers which are listed [here](https://www.cvxpy.org/tutorial/advanced/index.html).
110105

111106
### Installing
112107

@@ -116,13 +111,7 @@ The code is compatible with >=Python 3.5. It can be installed using pip or direc
116111
* From source using pip git+: `pip install git+https://github.com/florisvb/PyNumDiff`
117112
* From local source code using setup.py: Run `pip install .` from inside this directory. See below for example.
118113

119-
For additional solvers, run `pip install pynumdiff[advanced]`. This includes `cvxpy`,
120-
which can be tricky when compiling from source. If an error occurs in installing
121-
`cvxpy`, see [cvxpy install documentation](https://www.cvxpy.org/install/), install
122-
`cvxpy` according to those instructions, and try `pip install pynumdiff[advanced]`
123-
again.
124-
125-
<em>Note: If using the optional MOSEK solver for cvxpy you will also need a [MOSEK license](https://www.mosek.com/products/academic-licenses/), free academic license.</em>
114+
Call `pip install pynumdiff[advanced]` to automatically install [CVXPY](https://www.cvxpy.org) along with PyNumDiff. <em>Note: Some CVXPY solvers require a license, like ECOS and MOSEK. The latter offers a [free academic license](https://www.mosek.com/products/academic-licenses/).</em>
126115

127116
## Usage
128117

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ package = "https://pypi.org/project/pynumdiff/"
3636

3737
[project.optional-dependencies]
3838
advanced = [
39-
"cvxpy",
40-
"MOSEK",
39+
"cvxpy"
4140
]
4241
dev = [
4342
"pylint",

0 commit comments

Comments
 (0)