Skip to content

Commit

Permalink
Update pyproject.toml and README (bluesky#34)
Browse files Browse the repository at this point in the history
* looking at bluesky master

* Improve first paragraph of README
  • Loading branch information
rosesyrett authored Oct 23, 2023
1 parent 30ffafe commit 9f46520
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
24 changes: 13 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
***********
Ophyd Async
***********
===========

|build_status| |coverage| |pypi_version| |license|

ophyd-async is a Python library for asynchronously interfacing with hardware,
building upon the logic of `Ophyd`_. It is intended to be used as an
abstraction layer that enables experiment orchestration and data acquisition
code to operate above the specifics of particular devices and control systems.
Asynchronous device abstraction framework, building on `Ophyd`_.

============== ==============================================================
PyPI ``pip install ophyd-async``
Source code https://github.com/bluesky/ophyd-async
Documentation https://blueskyproject.io/ophyd-async
============== ==============================================================

Python library for asynchronously interfacing with hardware, intended to
be used as an abstraction layer that enables experiment orchestration and data
acquisition code to operate above the specifics of particular devices and control
systems.

Both ophyd and ophyd-async are typically used with the `Bluesky Run Engine`_ for
experiment orchestration and data acquisition. However, these libraries are
Expand All @@ -25,11 +32,6 @@ also. In addition to the abstractions provided by ophyd, ophyd-async allows:
upon complex class hierarchies

NOTE: ophyd-async is included on a provisional basis until the v1.0 release.
============== ==============================================================
PyPI ``pip install ophyd-async``
Source code https://github.com/bluesky/ophyd-async
Documentation https://blueskyproject.io/ophyd-async
============== ==============================================================

See the tutorials for usage examples.

Expand Down
3 changes: 1 addition & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dependencies = [
"numpy",
"packaging",
"pint",
"bluesky @ git+https://github.com/coretl/bluesky.git@async-stage",
"bluesky @ git+https://github.com/bluesky/bluesky.git",
"event-model",
"p4p==4.1.11a2",
] # Add project dependencies here, e.g. ["click", "numpy"]
Expand All @@ -36,7 +36,6 @@ dev = [
"ophyd_async[ca]",
"attrs>=19.3.0",
"black",
"bluesky @ git+https://github.com/coretl/bluesky.git@async-stage",
"caproto[standard] >=0.4.2rc1",
"pytest-codecov",
"databroker>=1.0.0b1",
Expand Down

0 comments on commit 9f46520

Please sign in to comment.