Skip to content

Commit 66bdd05

Browse files
committed
Make README a notebook to include the logo
1 parent c1e228e commit 66bdd05

File tree

2 files changed

+61
-53
lines changed

2 files changed

+61
-53
lines changed

README.md

Lines changed: 44 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,33 @@
11
---
2-
substitutions:
3-
Binder: |-
4-
```{image} https://mybinder.org/badge.svg
5-
:target: https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=example-notebook.ipynb
6-
```
7-
Conda: |-
8-
```{image} https://img.shields.io/badge/install%20with-conda-green.svg
9-
:target: https://anaconda.org/conda-forge/adaptive
10-
```
11-
Coverage: |-
12-
```{image} https://img.shields.io/codecov/c/github/python-adaptive/adaptive
13-
:target: https://codecov.io/gh/python-adaptive/adaptive
14-
```
15-
DOI: |-
16-
```{image} https://img.shields.io/badge/doi-10.5281%2Fzenodo.1182437-blue.svg
17-
:target: https://doi.org/10.5281/zenodo.1182437
18-
```
19-
Documentation: |-
20-
```{image} https://readthedocs.org/projects/adaptive/badge/?version=latest
21-
:target: https://adaptive.readthedocs.io/en/latest/?badge=latest
22-
```
23-
Downloads: |-
24-
```{image} https://img.shields.io/conda/dn/conda-forge/adaptive.svg
25-
:target: https://anaconda.org/conda-forge/adaptive
26-
```
27-
GitHub: |-
28-
```{image} https://img.shields.io/github/stars/python-adaptive/adaptive.svg?style=social
29-
:target: https://github.com/python-adaptive/adaptive/stargazers
30-
```
31-
Gitter: |-
32-
```{image} https://img.shields.io/gitter/room/nwjs/nw.js.svg
33-
:target: https://gitter.im/python-adaptive/adaptive
34-
```
35-
Pipeline status: |-
36-
```{image} https://dev.azure.com/python-adaptive/adaptive/_apis/build/status/python-adaptive.adaptive?branchName=master
37-
:target: https://dev.azure.com/python-adaptive/adaptive/_build/latest?definitionId=6?branchName=master
38-
```
39-
PyPI: |-
40-
```{image} https://img.shields.io/pypi/v/adaptive.svg
41-
:target: https://pypi.python.org/pypi/adaptive
42-
```
43-
logo: |-
44-
```{image} https://adaptive.readthedocs.io/en/latest/_static/logo.png
45-
```
2+
kernelspec:
3+
name: python3
4+
display_name: python3
5+
jupytext:
6+
text_representation:
7+
extension: .md
8+
format_name: myst
9+
format_version: '0.13'
10+
jupytext_version: 1.13.8
4611
---
4712

4813
% summary-start
4914

50-
# {{ logo }} adaptive
15+
# ![logo](logo) adaptive
5116

52-
{{ PyPI }} {{ Conda }} {{ Downloads }} {{ Pipeline status }} {{ DOI }} {{ Binder }} {{ Gitter }}
53-
{{ Documentation }} {{ Coverage }} {{ GitHub }}
17+
[![PyPI][PyPI-badge]][PyPI-url]
18+
[![Conda][Conda-badge]][Conda-url]
19+
[![Downloads][Downloads-badge]][Downloads-url]
20+
[![Pipeline-status][Pipeline-status-badge]][Pipeline-status-url]
21+
[![DOI][DOI-badge]][DOI-url]
22+
[![Binder][Binder-badge]][Binder-url]
23+
[![Gitter][Gitter-badge]][Gitter-url]
24+
[![Documentation][Documentation-badge]][Documentation-url]
25+
[![Coverage][Coverage-badge]][Coverage-url]
26+
[![GitHub][GitHub-badge]][GitHub-url]
5427

5528
> *Adaptive*: parallel active learning of mathematical functions.
5629
57-
```{eval-rst}
58-
.. include:: logo.rst
30+
```{include} logo.md
5931
```
6032

6133
`adaptive` is an open-source Python library designed to make adaptive parallel function evaluation simple. With `adaptive` you just supply a function with its bounds, and it will be evaluated at the “best” points in parameter space, rather than unnecessarily computing *all* points on a dense grid.
@@ -96,7 +68,7 @@ In addition to the learners, `adaptive` also provides primitives for running the
9668
[concurrent.futures](https://docs.python.org/3/library/concurrent.futures.html),
9769
[mpi4py](https://mpi4py.readthedocs.io/en/stable/mpi4py.futures.html),
9870
[loky](https://loky.readthedocs.io/en/stable/),
99-
[ipyparallel](https://ipyparallel.readthedocs.io/en/latest/) and
71+
[ipyparallel](https://ipyparallel.readthedocs.io/en/latest/), and
10072
[distributed](https://distributed.readthedocs.io/en/latest/).
10173

10274
## Examples
@@ -211,3 +183,25 @@ For general discussion, we have a [Gitter chat channel](https://gitter.im/python
211183
% references-start
212184

213185
% references-end
186+
187+
[logo]: https://adaptive.readthedocs.io/en/latest/_static/logo.png
188+
[Binder-badge]: https://mybinder.org/badge.svg
189+
[Binder-url]: https://mybinder.org/v2/gh/python-adaptive/adaptive/master?filepath=example-notebook.ipynb
190+
[Conda-badge]: https://img.shields.io/badge/install%20with-conda-green.svg
191+
[Conda-url]: https://anaconda.org/conda-forge/adaptive
192+
[Coverage-badge]: https://img.shields.io/codecov/c/github/python-adaptive/adaptive
193+
[Coverage-url]: https://codecov.io/gh/python-adaptive/adaptive
194+
[DOI-badge]: https://img.shields.io/badge/doi-10.5281%2Fzenodo.1182437-blue.svg
195+
[DOI-url]: https://doi.org/10.5281/zenodo.1182437
196+
[Documentation-badge]: https://readthedocs.org/projects/adaptive/badge/?version=latest
197+
[Documentation-url]: https://adaptive.readthedocs.io/en/latest/?badge=latest
198+
[Downloads-badge]: https://img.shields.io/conda/dn/conda-forge/adaptive.svg
199+
[Downloads-url]: https://anaconda.org/conda-forge/adaptive
200+
[GitHub-badge]: https://img.shields.io/github/stars/python-adaptive/adaptive.svg?style=social
201+
[GitHub-url]: https://github.com/python-adaptive/adaptive/stargazers
202+
[Gitter-badge]: https://img.shields.io/gitter/room/nwjs/nw.js.svg
203+
[Gitter-url]: https://gitter.im/python-adaptive/adaptive
204+
[Pipeline-status-badge]: https://dev.azure.com/python-adaptive/adaptive/_apis/build/status/python-adaptive.adaptive?branchName=master
205+
[Pipeline-status-url]: https://dev.azure.com/python-adaptive/adaptive/_build/latest?definitionId=6?branchName=master
206+
[PyPI-badge]: https://img.shields.io/pypi/v/adaptive.svg
207+
[PyPI-url]: https://pypi.python.org/pypi/adaptive

docs/source/logo.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1-
```{jupyter-execute} ../logo_animated.py
2-
:hide-code:
3-
:hide-output:
1+
---
2+
kernelspec:
3+
name: python3
4+
display_name: python3
5+
jupytext:
6+
text_representation:
7+
extension: .md
8+
format_name: myst
9+
format_version: '0.13'
10+
jupytext_version: 1.13.8
11+
---
12+
13+
```{code-cell}
14+
---
15+
tags: [remove-input]
16+
---
17+
:load: ../logo_animated.py
418
```
519

620
```{raw} html

0 commit comments

Comments
 (0)