From 46d2965010e97be930f4b08136062429deab2da7 Mon Sep 17 00:00:00 2001 From: Tom Cobb Date: Tue, 2 Jan 2024 13:57:14 +0000 Subject: [PATCH] Tweaks --- README.md | 19 +++++++++++-------- docs/conf.py | 2 +- docs/images/scanspec-logo.ico | Bin 10462 -> 0 bytes 3 files changed, 12 insertions(+), 9 deletions(-) delete mode 100644 docs/images/scanspec-logo.ico 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 75349e66c9ac3da6c0c933d072ec06c999aedc4d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 10462 zcmeH~&ubGw6vsz$@FG=E^r$z36bgmjgw4U51zRXRcozC6^w=Cc8gfv26faT?dh^t1 zS+p%VNP_uc%s~)5iy}o7HjLkw>|3Uj-DIa*lUdy@uP-yq?tDM<-ux2c4E`1u1^!a!=^BhYHK+-9@sq?L|Gw`dN6M8-B{zvjdyjKW zTEfA49-DHUL_g=?DdiPwKjsmam2oUeJgk`KolfT*G%dqEDcU4BY7;oD(64KR?mRd= zg{9x^b}#Df(ohCNL*bBEzn0RVTi2Lo4&;*q{dC3{$*W$kcS&cpt&I776Z)%49>tpH zv{&MtZ5ZvHNBQd?WFouq{`dTod1-2E&)4M6;m)x&R$)==SJknny%8}hqitVppNN6R zz>vd0Ke3GLgH)&L=iiocgq}+fhZWYX`)PA<{*8%CHBCRwrDfVf)!duKZ+)Ie zX`nR=n$l1yrEHor(yJ1l*cjq1l>eO1;^y)M@MJShXcZ^B@ppLj<0L8=R5 zwv;3ETta(d7z5Q!n}cIFCNA0ie8y`ob)VhOEeL{vgzSE9Fj!M+iuHBk{rp9}F7F;3 z$OYFmvL$!-XJhY*Olon50xY5XpuVq|@=Ti}?)}_$4vt&Y{oGVP=ijvB!5r+Be6r$x z&bmxJI8vow4jxyq_x!Tw&<|I5Gypl@3*8sQpq&d(&A*G`cYbN!^~<6l&;(BbU!uni ze36Rir%2y9?}{AxhAYmJhYt3`4$#gS*7JKVy{~+a`>{fw<8vy0pbzC>oCyb