Get started with PyCharm¶
PyCharm is a popular python editor. This is a quickstart guide setting up PyCharm for developing sksurgery. This assumes you have PyCharm installed and configured to support virtual environments.
- Start PyCharm
- Select File > Open
- Select the project’s folder
- Open in a new window
- Open Preferences
- Click on Project: [YourProject] and select Project Interpreter
- At the right of the Project Interpreterm, click the cog
- Select Add Local…
- Select Virtual Environment
- Choose a location for your virtual environment (for example, [YourHomeFolder]/VirtualEnvs/[YourProjectName])
- Select a base interpreter (usually the latest version of Python 3).
- Recommended settings: Do not inherit global site-packages, and do not make available to all projects.
- Click OK
- Click on Terminal
- pip install tox
- tox
- Expand the project
- Right-click on the Tests folder and choose “Run Unittests in tests”. This will create a new configuration for running tests
- Right-click on sksurgery and select Run sksurgery. This will create a new configuration for running the project.
- Switch between the program and test configurations using the drop-down at the top of the screen, and the green arrow to run or the green bug to debug.