diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 4bd5f82..77b41b8 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -31,4 +31,5 @@ - [Clocking](sw_sup/clocking.md) - [device_db.py](sw_sup/device_db.md) - [Setup your PC for building ARTIQ firmware](sw_sup/setup_build_pc.md) - - [AFWS client](sw_sup/afws_client.md) \ No newline at end of file + - [AFWS client](sw_sup/afws_client.md) + - [Integration with PyCharm](sw_sup/pycharm.md) \ No newline at end of file diff --git a/src/img/win32/pycharm_interpreter.png b/src/img/win32/pycharm_interpreter.png new file mode 100644 index 0000000..e97bb64 Binary files /dev/null and b/src/img/win32/pycharm_interpreter.png differ diff --git a/src/img/win32/pycharm_terminal.png b/src/img/win32/pycharm_terminal.png new file mode 100644 index 0000000..6883d5b Binary files /dev/null and b/src/img/win32/pycharm_terminal.png differ diff --git a/src/sw_sup/pycharm.md b/src/sw_sup/pycharm.md new file mode 100644 index 0000000..ee1fa86 --- /dev/null +++ b/src/sw_sup/pycharm.md @@ -0,0 +1,17 @@ +# Integration with PyCharm® + +It's fairly possible to integrate PyCharm with ARTIQ on Windows. + +## MSYS2 + +Below is an example configuration, change it according your installation. + +1. Set System Interpreter to MSYS2 CLANG64 one (pip packages are not supported): + ![](../img/win32/pycharm_interpreter.png) +2. Set Terminal to use MSYS2 CLANG64 one: + ![](../img/win32/pycharm_terminal.png) + +After this you will be able to look up definitions from ARTIQ and use convenient integrated Terminal to run `artiq_run`. + + +_PyCharm is a registered trademark of JetBrains s.r.o.. For license information, please refer to the JetBrains website or the product documentation._