Merge pull request #26 from zalgo3/fix-broken-codes

fix broken codes

README.md

@@ -22,35 +22,44 @@ Note that FISTA also requires $f$ to be convex.
 
 - Documentation: https://zalgo3.github.io/zfista/
 
-## Requirements
+### Requirements
 - Python 3.9 or later
 
-## Install
-```sh
+### Install
+```Shell
 pip install zfista
 ```
 
-## Quickstart
+### Quickstart
 ```python
 from zfista import minimize_proximal_gradient
 help(minimize_proximal_gradient)
 ```
 
-## Examples
+## For developers
+
+### Installation
+```Shell
+pip install -e .
+```
+
+### Examples
 You can run some examples on jupyter notebooks.
 ```Shell
+pip install -e ".[examples]"
 jupyter notebook
 ```
 
-## Testing
+### Testing
 You can run all tests by
 ```Shell
-python -m unittest discover
+pip install tox
+tox
 ```
 
-## Benchmark
+### Benchmark
 You can run the benchmark by
 ```Shell
-pip install -U joblib matplotlib pandas SciencePlots tqdm
+pip install -e ".[bench]"
 python runtests.py
 ```

benchmarks/benchmark.py

@@ -12,6 +12,7 @@
 import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
+import scienceplots  # noqa: F401
 from joblib import Parallel, delayed
 from mpl_toolkits.mplot3d import Axes3D
 from tqdm.auto import tqdm