⚠️ Warning
This library is deprecated; it will no longer be maintained and will not receive further updates.
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-seascapeOR
python -m pip install ansys-seascapeInstall 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.ps1Install 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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ansys_seascape-0.2.1.tar.gz.
File metadata
- Download URL: ansys_seascape-0.2.1.tar.gz
- Upload date:
- Size: 10.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d4c25feeb527bad8d5c0e83fe1a0e43c4d51a618ad875a1fb66a83acb9ed67d1
|
|
| MD5 |
7d8f494f1cbedba51b07418d7532416f
|
|
| BLAKE2b-256 |
80c8c504a07431878405ce6635ad651adee31a1e6522a678fddd3b9c46d49686
|
Provenance
The following attestation bundles were made for ansys_seascape-0.2.1.tar.gz:
Publisher:
ci_cd.yml on ansys/pyseascape
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ansys_seascape-0.2.1.tar.gz -
Subject digest:
d4c25feeb527bad8d5c0e83fe1a0e43c4d51a618ad875a1fb66a83acb9ed67d1 - Sigstore transparency entry: 2697420692
- Sigstore integration time:
-
Permalink:
ansys/pyseascape@df5445246c9206f4552d2666da024c0491b635a4 -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/ansys
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_cd.yml@df5445246c9206f4552d2666da024c0491b635a4 -
Trigger Event:
push
-
Statement type:
File details
Details for the file ansys_seascape-0.2.1-py3-none-any.whl.
File metadata
- Download URL: ansys_seascape-0.2.1-py3-none-any.whl
- Upload date:
- Size: 12.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28d116aaf916811e59b73649ecbf9f838a6d6aa2b23bcdeaabb1299b94539f4e
|
|
| MD5 |
ec3e6d409d591bac9df5ba0eb0be0e27
|
|
| BLAKE2b-256 |
f16735bee6e9685e8bed6b01bcca38e2a2f70b18ed535125a2b3806eb90acd39
|
Provenance
The following attestation bundles were made for ansys_seascape-0.2.1-py3-none-any.whl:
Publisher:
ci_cd.yml on ansys/pyseascape
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ansys_seascape-0.2.1-py3-none-any.whl -
Subject digest:
28d116aaf916811e59b73649ecbf9f838a6d6aa2b23bcdeaabb1299b94539f4e - Sigstore transparency entry: 2697420800
- Sigstore integration time:
-
Permalink:
ansys/pyseascape@df5445246c9206f4552d2666da024c0491b635a4 -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/ansys
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci_cd.yml@df5445246c9206f4552d2666da024c0491b635a4 -
Trigger Event:
push
-
Statement type:
