Skip to content

Commit

Permalink
Update executor how-to hyperlinks (#127)
Browse files Browse the repository at this point in the history
* fixes issue 126

* fixes issue 126

* fixes issue 126

* fixes issue 126

* fixes issue 126

* fixes issue 126
  • Loading branch information
HaimHorowitzAgnostiq authored Feb 17, 2022
1 parent 851d4e4 commit 57366a9
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 3 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.24.20] - 2022-02-17

### Added

- Added how to create custom executors

### Changed

- Changed the description of the hyperlink for choosing executors
- Fixed typos in doc/source/api/getting_started/how_to/execution/creating_custom_executors.ipynb

## [0.24.19] - 2022-02-16

### Added
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.24.19
0.24.20
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"## How to create a custom executor\n",
"\n",
"<font size=\"3\">\n",
"Each electron can utilise different so-called executors. These exectors define the low-level directions for the computation. They can specify different capabilities, _eg_, different hardware, different computation strategy, different logic, or simply differnt goals.\n",
"Each electron can utilise different so-called executors. These executors define the low-level directions for the computation. They can specify different capabilities, _eg_, different hardware, different computation strategy, different logic, or simply different goals.\n",
"\n",
"Executors are plugins; any executor-plugins which are found are imported as classes in the covalent.executor name-space.\n",
"See the how-to on [choosing an executor to be used in an electron](choosing_executors.ipynb) for details on simply choosing an executor. Here, we go through the steps, line-by-line, on how to make your own.\n",
Expand Down
3 changes: 2 additions & 1 deletion doc/source/how_to/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ Execution
- :doc:`How to execute a lattice as an electron inside another lattice <./execution/execute_sublattice>`
- :doc:`How to execute an electron in a Conda environment <./execution/choosing_conda_environments>`
- :doc:`How to synchronize lattices <./execution/synchronize_lattice>`
- :doc:`How to customize the executor <./execution/choosing_executors>`
- :doc:`How to choose the executor <./execution/choosing_executors>`
- :doc:`How to customize the executor <./execution/creating_custom_executors>`
- :doc:`How to cancel a running workflow <./execution/cancel_dispatch>`

Status
Expand Down

0 comments on commit 57366a9

Please sign in to comment.