1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,11 @@ |
1 |
+# Adaptive Authors |
|
2 |
+Below is a list of the main contributors to Adaptive: |
|
3 |
+ |
|
4 |
++ [Anton Akhmerov](<https://antonakhmerov.org>) |
|
5 |
++ [Bas Nijholt](<http://nijho.lt>) |
|
6 |
++ [Joseph Weston](<https://joseph.weston.cloud>) |
|
7 |
+ |
|
8 |
+For a full list of contributors run |
|
9 |
+ |
|
10 |
+ :::bash |
|
11 |
+ git log --pretty=format:"%an" | sort | uniq |
... | ... |
@@ -6,7 +6,7 @@ |
6 | 6 |
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=learner.ipynb) |
7 | 7 |
[![Join the chat at https://gitter.im/python-adaptive/adaptive](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/python-adaptive/adaptive) |
8 | 8 |
|
9 |
-**Tools for adaptive parallel evaluation of functions.** |
|
9 |
+**Tools for adaptive parallel sampling of mathematical functions.** |
|
10 | 10 |
|
11 | 11 |
`adaptive` is an [open-source](LICENSE) Python library designed to make adaptive parallel function evaluation simple. |
12 | 12 |
With `adaptive` you just supply a function with its bounds, and it will be evaluated at the "best" points in parameter space. |
... | ... |
@@ -19,7 +19,7 @@ Check out the `adaptive` [example notebook `learner.ipynb`](learner.ipynb) (or r |
19 | 19 |
|
20 | 20 |
|
21 | 21 |
## Implemented algorithms |
22 |
-The core concept in `adaptive` is that of a "learner". A "learner" samples |
|
22 |
+The core concept in `adaptive` is that of a *learner*. A *learner* samples |
|
23 | 23 |
a function at the best places in its parameter space to get maximum |
24 | 24 |
"information" about the function. As it evaluates the function |
25 | 25 |
at more and more points in the parameter space, it gets a better idea of where |
... | ... |
@@ -54,17 +54,31 @@ and [`distributed`](https://distributed.readthedocs.io/en/latest/). |
54 | 54 |
|
55 | 55 |
The recommended way to install adaptive is using `pip`: |
56 | 56 |
```bash |
57 |
-pip install https://gitlab.kwant-project.org/qt/adaptive/repository/master/archive.zip |
|
57 |
+pip install adaptive[notebook] |
|
58 | 58 |
``` |
59 | 59 |
|
60 |
+The `[notebook-extras]` above will also install the optional dependencies for running `adaptive` inside |
|
61 |
+a Jupyter notebook. |
|
62 |
+ |
|
60 | 63 |
|
61 | 64 |
## Development |
65 |
+Clone the repository and run `setup.py develop` to add a link to the cloned repo into your |
|
66 |
+Python path: |
|
67 |
+``` |
|
68 |
+git clone git@github.com:python-adaptive/adaptive.git |
|
69 |
+cd adaptive |
|
70 |
+python3 setup.py develop |
|
71 |
+``` |
|
72 |
+ |
|
73 |
+We highly recommend using a Conda environment or a virtualenv to manage the versions of your installed |
|
74 |
+packages while working on `adaptive`. |
|
62 | 75 |
|
63 | 76 |
In order to not pollute the history with the output of the notebooks, please setup the git filter by executing |
64 | 77 |
|
65 | 78 |
```bash |
66 | 79 |
git config filter.nbclearoutput.clean "jupyter nbconvert --to notebook --ClearOutputPreprocessor.enabled=True --ClearOutputPreprocessor.remove_metadata_fields='[\"deletable\", \"editable\", \"collapsed\", \"scrolled\"]' --stdin --stdout" |
67 | 80 |
``` |
81 |
+ |
|
68 | 82 |
in the repository. |
69 | 83 |
|
70 | 84 |
|
... | ... |
@@ -15,7 +15,7 @@ install_requires = [ |
15 | 15 |
] |
16 | 16 |
|
17 | 17 |
extras_require = { |
18 |
- 'recommended': [ |
|
18 |
+ 'notebook': [ |
|
19 | 19 |
'ipython', |
20 | 20 |
'ipykernel>=4.8.0', # because https://github.com/ipython/ipykernel/issues/274 and https://github.com/ipython/ipykernel/issues/263 |
21 | 21 |
'jupyter_client>=5.2.2', # because https://github.com/jupyter/jupyter_client/pull/314 |
... | ... |
@@ -29,7 +29,7 @@ extras_require = { |
29 | 29 |
|
30 | 30 |
setup( |
31 | 31 |
name='adaptive', |
32 |
- description='Adaptively sample mathematical functions', |
|
32 |
+ description='Adaptive parallel sampling of mathematical functions', |
|
33 | 33 |
version='0.1a', |
34 | 34 |
url='https://gitlab.kwant-project.org/qt/adaptive', |
35 | 35 |
author='Adaptive authors', |