PySeascape library

A pythonic remotable interface to RedHawkSC and TotemSC that allows integration with other PyAnsys and Python libraries.

How to install

Install from PyPI

User installation can be performed by running:

pip install ansys-seascape

OR

python -m pip install ansys-seascape

Install from latest Github source

Fetch latest source from github:

cd <your-library-directory>
git clone https://github.com/ansys/pyseascape.git

(Optional) Create and enable virtual environment. Please refer to official venv documentation for more help regarding virtual environment setup.

# Create a virtual environment
python -m venv .venv

# Activate it in a POSIX system
source .venv/bin/activate

# Activate it in Windows CMD environment
.venv\Scripts\activate.bat

# Activate it in Windows Powershell
.venv\Scripts\Activate.ps1

Install the project

cd pyseascape
pip install .

Install additional requirements (if needed):

python -m pip install .[tests]
python -m pip install .[doc]

Usage

Note: Either a local installation or remote connection to licensed RedHawk-SC is required to use the pyseascape library. This only offers a remotable frontend interface that can run directly in native Python on any machine.

Launching local RedHawk-SC in backend

from ansys.seascape import RedHawkSC

gp = RedHawkSC(executable=path_to_executable)

OR

from ansys import seascape

gp = seascape.RedHawkSC(executable=path_to_executable)

Connecting to remote RedHawk-SC session

from ansys.seascape import RedHawkSC

url_and_port = url_or_ip_to_redhawksc_server + ":" + port
gp = RedHawkSC(url=url_and_port)

All RedHawk-SC global functions can be called using prefix of RedHawkSC object name. Object methods can be called as normal.

Running RedHawk-SC commands

For example:

# If gp = RedHawkSC(...)
db = gp.open_db(db_name)  # Returns a SeascapeDB remotable object
db.create_design_view(...)

# Creating RedHawk-SC objects
inst = gp.Instance("Inst_Name")

# RedHawk-SC modules must also be prefixed by gp
# E.g. using voltage_impact module
gp.voltage_impact.helpers.get_pgimpact_histograms(...)

Accessing RedHawk-SC help

RedHawk-SC native help function supports command based as well as keyword based help. This help can be accessed remotely as well.

# If gp = RedHawkSC(...)

# command based help
gp.help(command="gp.Scatter")

# keyword based help
gp.help(keyword="scatter")

Known issues and limitations

GUI features have not yet been implemented. Hence, commands like open_console_window, open_scheduler_window etc. do not work yet. Commands like gp.scatter_plot also does not work as it requires drawing gui plots

Documentation

Please refer to RedHawk-SC Documentation.