diff --git a/README.md b/README.md index c5e0325a..fcc5fa0c 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ -# ![logo][] scanspec + +# scanspec [![CI](https://github.com/dls-controls/scanspec/actions/workflows/code.yml/badge.svg)](https://github.com/dls-controls/scanspec/actions/workflows/code.yml) [![Coverage](https://codecov.io/gh/dls-controls/scanspec/branch/master/graph/badge.svg)](https://codecov.io/gh/dls-controls/scanspec) [![PyPI](https://img.shields.io/pypi/v/scanspec.svg)](https://pypi.org/project/scanspec) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -Specify step and flyscan Paths using combinations of: + +Specify step and flyscan Paths using combinations of: - Specs like Line or Spiral - Optionally Snaking - Zip, Product and Concat to compose @@ -19,13 +21,13 @@ can be produced and expanded Paths created to consume chunk by chunk. [cycler]: https://matplotlib.org/cycler/ Source | ---- | --- +:---: | :---: PyPI | `pip install scanspec` Documentation | Releases | An example ScanSpec of a 2D snaked grid flyscan inside a circle spending 0.4s at -each point looks like: +each point: ```python from scanspec.specs import Line, fly @@ -35,9 +37,11 @@ grid = Line(y, 2.1, 3.8, 12) * ~Line(x, 0.5, 1.5, 10) spec = fly(grid, 0.4) & Circle(x, y, 1.0, 2.8, radius=0.5) ``` +Which when plotted looks like: + ![plot][] -You can then either iterate through the scan positions directly for convenience: +Scan points can be iterated through directly for convenience: ```python for point in spec.midpoints(): @@ -47,8 +51,8 @@ for point in spec.midpoints(): # {'y': 3.1818181818181817, 'x': 0.7222222222222222, 'DURATION': 0.4} ``` -or create a Path from the stack of Frames and consume chunks of a given length -from it for performance: +or a Path created from the stack of Frames and chunks of a given length +consumed from it for performance: ```python from scanspec.core import Path @@ -69,6 +73,5 @@ when included in index.md --> [plot]: https://raw.githubusercontent.com/dls-controls/scanspec/master/docs/images/plot_spec.png -[logo]: https://raw.githubusercontent.com/dls-controls/scanspec/master/docs/images/scanspec-logo.svg See https://dls-controls.github.io/scanspec for more detailed documentation. diff --git a/docs/conf.py b/docs/conf.py index 02ada29f..3edbf9f8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -211,4 +211,4 @@ # Logo html_logo = "images/scanspec-logo.svg" -html_favicon = "images/scanspec-logo.ico" +html_favicon = html_logo diff --git a/docs/images/scanspec-logo.ico b/docs/images/scanspec-logo.ico deleted file mode 100644 index 75349e66..00000000 Binary files a/docs/images/scanspec-logo.ico and /dev/null differ