Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
engine
engine
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 5
    • Issues 5
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 0
    • Merge Requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Pulse Physiology Suite
  • engineengine
  • Wiki
  • Using Pycharm

Last edited by Aaron Bray Jun 25, 2020
Page history

Using Pycharm

Currently, to use the Pulse Python API, you must build Pulse and enable the Pulse_PYTHON_API option. We hope to have pyip support is the future.

image

Once Pulse is built with Python support, the easiest way to get started with the Pulse Python API is to use PyCharm.

Open The Pulse Project In PyCharm

From the initial PyCharm splash screen, choose the Open option.

image

Navigate to your Pulse source code folder and select the src/python folder.

image

Add the Pulse to your PYTHONPATH

From the File menu option, select Settings

Navigate to the Project:python option and select Project Interpreter

image

Ensure you have a Python interpreter selected ( one of version >= 3.6 is suggested)

Click on the Cog Icon to the right of the selected interpreter drop down, and select Show All

image

Next, click on the bottom icon (Folder hierarchy) of the vertically arranged buttons.

The tooltip of the button is Show paths for the selected interpreter

image

Add the path to your Pulse build install\bin directory

And click the many OK buttons to close out all settings windows.

Next, From the Run menu option, select the Edit Configurations... option

Select the Python option under Templates and set the Working directory field to your Pulse build install/bin folder, and hit OK

image

Now you can right-click any of the How-To files and Debug/Run them!

image

Create your own python files or modify ours, and let us know if you have any issues on our discourse forum!

Clone repository
  • Adding a Parameter
  • Contributing to Pulse
  • Creating a Scenario
  • Creating a Unit Test
  • Creating a condition
  • Creating an Action
  • Extending a System
  • Generating Documentation
  • Modifying a System Circuit
  • Pulse Scenario Driver
  • Test Suite
  • Updating Baselines
  • Updating Documentation
  • Using C#
  • Using CLion
View All Pages