aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJ08nY2023-07-24 15:18:34 +0200
committerJ08nY2023-07-24 15:18:34 +0200
commitfbf3e4530971a93ca9e5e2e2822665f319ced2b9 (patch)
tree01274ac77a1bc3b648aad9107caf71b5a2db29c4
parentb0ab971e1eda6b31e4f0a0f5035aa87e2322fabc (diff)
downloadpyecsca-fbf3e4530971a93ca9e5e2e2822665f319ced2b9.tar.gz
pyecsca-fbf3e4530971a93ca9e5e2e2822665f319ced2b9.tar.zst
pyecsca-fbf3e4530971a93ca9e5e2e2822665f319ced2b9.zip
-rw-r--r--README.md4
-rw-r--r--docs/index.rst6
2 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index bb16813..c774280 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,8 @@ multiplier and even finite-field implementation details.
It is currently in an alpha stage of development and thus only provides:
- Enumeration of millions of possible ECC implementation configurations (see [notebook/configuration_space](https://neuromancer.sk/pyecsca/notebook/configuration_space.html))
- Simulation and execution tracing of key generation, ECDH and ECDSA (see [notebook/simulation](https://neuromancer.sk/pyecsca/notebook/simulation.html))
- - Synthesis of C implementations of ECC for embedded devices, given any implementation configuration (see [notebook/codegen](https://neuromancer.sk/pyecsca/notebook/codegen.html))
+ - Synthesis of C implementations of ECC for embedded devices, given any implementation configuration (see [notebook/codegen](https://neuromancer.sk/pyecsca/notebook/codegen.html)),
+ CPU-level simulation of implementations (see [notebook/simulator](https://neuromancer.sk/pyecsca/notebook/simulator.html))
- Trace acquisition using PicoScope/ChipWhisperer oscilloscopes (see [notebook/measurement](https://neuromancer.sk/pyecsca/notebook/measurement.html))
- Trace processing capabilities, e.g. signal-processing, filtering, averaging, cutting, aligning ([pyecsca.sca](https://neuromancer.sk/pyecsca/api/pyecsca.sca.html))
- Trace visualization using holoviews and datashader (see [notebook/visualization](https://neuromancer.sk/pyecsca/notebook/visualization.html))
@@ -43,6 +44,7 @@ It is currently in an alpha stage of development and thus only provides:
- [matplotlib](https://matplotlib.org/)
- [xarray](https://xarray.pydata.org/en/stable/)
- [astunparse](https://astunparse.readthedocs.io/)
+ - [numba](https://numba.pydata.org/)
- **Optionally**:
- **Oscilloscope support:**
- [picosdk](https://github.com/picotech/picosdk-python-wrappers/)
diff --git a/docs/index.rst b/docs/index.rst
index 4d9a3c6..d8788d6 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -36,7 +36,8 @@ It is currently in an alpha stage of development and thus only provides:
.. card:: Code generation
- Synthesis of C implementations of ECC for embedded devices, given any implementation configuration (see :doc:`notebook/codegen`)
+ Synthesis of C implementations of ECC for embedded devices, given any implementation configuration (see :doc:`notebook/codegen`),
+ CPU-level simulation of implementations (see :doc:`notebook/simulator`)
.. card:: Trace acquisition
@@ -87,6 +88,7 @@ are the best source of documentation on how to use **pyecsca**.
notebook/configuration_space
notebook/simulation
notebook/codegen
+ notebook/simulator
notebook/measurement
notebook/visualization
notebook/smartcards
@@ -119,6 +121,7 @@ Requirements
- matplotlib_
- xarray_
- astunparse_
+ - numba_
- **Optionally**:
- **Oscilloscope support:**
@@ -208,6 +211,7 @@ Development was supported by the Masaryk University grant `MUNI/C/1707/2018 <htt
.. _datashader: https://datashader.org
.. _xarray: https://xarray.pydata.org/en/stable/
.. _astunparse: https://astunparse.readthedocs.io/
+.. _numba: https://numba.pydata.org/
.. _picosdk: https://github.com/picotech/picosdk-python-wrappers/
.. _picoscope: https://github.com/colinoflynn/pico-python
.. _chipwhisperer: https://github.com/newaetech/chipwhisperer