Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jackbdoughty committed Oct 8, 2024
1 parent 695ad61 commit ac720b9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 1 addition & 3 deletions doc/architectural_decisions/002-use-ophyd-async.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,4 @@ We will use `ophyd-async`.
- `ophyd-async` will allow us to do fly scanning, if required in future, more easily than `ophyd`
- Developers will need to understand more details about `asyncio`
- Developers will have to write somewhat less boilerplate code in `ophyd-async` as compared to `ophyd`
- Our devices should be more comparable to other facilities on site (e.g. DLS) who are using `ophyd-async`.
- Less expertise with this library on site (mitigation: don't do too much which is very complicated with it)
- Potentially duplicates some of mantid's functionality: (mitigation: use scipp for "simple" things, use mantid in future if people want to do "full" data reduction pipelines)
- Our devices should be more comparable to other facilities on site (e.g. DLS) who are using `ophyd-async`.
4 changes: 3 additions & 1 deletion doc/architectural_decisions/004-use-scipp.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,6 @@ We will be using scipp.
- `scipp` is being developed at ESS with past input from STFC, so is well suited for neutron counts data.
- `scipp` has a `numpy`-like interface but handles units and uncertainties by default under-the-hood.
- Neither `numpy` or `uncertanties` have exactly the functionality we would need, so the solution using them would be a mix of the libraries and our own code, there would be more places to go wrong. Maintainability.
- Developing our own uncertainties library will take time to understand and then implement. All of the functionality that we need has been done beforehand, so better to not waste time & effort.
- Developing our own uncertainties library will take time to understand and then implement. All of the functionality that we need has been done beforehand, so better to not waste time & effort.
- Less expertise with this library on site (mitigation: don't do too much which is very complicated with it)
- Potentially duplicates some of `mantid`'s functionality: (mitigation: use `scipp` for "simple" things, use `mantid` in future if people want to do "full" data reduction pipelines)

0 comments on commit ac720b9

Please sign in to comment.