docs: add note for import error related to numpy2 release (#350)

* add note for import error related to numpy2 release Signed-off-by: ymski <[email protected]> * ci(pre-commit): autofix * docs: add update command Signed-off-by: ymski <[email protected]> * docs: fix style Signed-off-by: ymski <[email protected]> * update style Signed-off-by: ymski <[email protected]> * ci(pre-commit): autofix --------- Signed-off-by: ymski <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
tier4 · Aug 16, 2024 · c99ec98 · c99ec98
1 parent e0b8822
commit c99ec98
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/docs/faq/faq.md b/docs/faq/faq.md
@@ -25,6 +25,21 @@ ros2 caret check_caret_rclcpp <path-to-workspace>
       CARET CLI tool doesn't work properly in Anaconda environment. Please use pure Python.
 <prettier-ignore-end>
 
+### Import error caused by numpy2
+
+With the release of numpy2, the following warnings may occur depending on the environment.
+
+> A module that was compiled using NumPy 1.x cannot be run in
+> NumPy 2.0.1 as it may crash. To support both 1.x and 2.x
+> versions of NumPy, modules must be compiled with NumPy 2.0.
+> Some module may need to rebuild instead e.g. with 'pybind11>=2.12'.
+
+To use caret, it is sufficient to update packages using numpy. The packages can be updated by the following command.
+
+```bash
+pip3 install -U numexpr bottleneck matplotlib
+```
+
 ## Recording
 
 ### LTTng session doesn't start after `ros2 caret record`