A pythonic remotable interface to RedHawkSC and TotemSC
Project description
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/pyansys/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
Run the setup script
cd pyseascape
python setup.py install
Install additional requirements (if needed):
python -m pip install -r requirements_build.txt
python -m pip install -r requirements_doc.txt
python -m pip install -r requirements_tests.txt
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
gp = RedHawkSC(url=url_or_ip_to_redhawksc_server: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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for ansys_seascape-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5592748b38ad2e444b857c17e7d79e740971ac6c6bfd144edfb9f9b8638088d |
|
MD5 | 30d77844172752cb4ae58d50a6e4d8dc |
|
BLAKE2b-256 | c8096c3d0d4325ad12606d996886e16160431f16cb422c4cfa883d458a4e0451 |