Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions Markdown/developer_product_guide/3d_design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 3D Design

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add an introduction to each MD file corresponding to a collection. Below is an example:
This section provides a list of all Ansys products included in the 3D Design collection and specifies whether developer materials are available for each product.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there worth in adding boilerplate like that though? That statement is already present on the homepage. We're not expecting viewers to be reading through this document, rather it is intended to operate like a glossary or reference book where people search for the term they want and/or are interested in, go there and read about it, and then leave.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I get your point! I agree, let's leave the pages without an intro and focus on making the content easily navigable for quick access to information.

## SpaceClaim

### Ansys SpaceClaim training material

* [Scripting in Ansys SpaceClaim (ALH)](https://ansys.com/training-center/course-catalog/structures/scripting-in-ansys-spaceclaim-advanced)
* [Geometry Scripting Ansys SpaceClaim for Rapid Model Changes](https://www.ansys.com/en-gb/blog/spaceclaim-geometry-scripting)

### Non-Ansys SpaceClaim training material

* [How to Use SpaceClaim Scripting to Parameterize Your Models (Mallett Technology)](https://www.youtube.com/watch?v=U98qtKWUoL8)
* [Much Ado About Scripting in Ansys SpaceClaim (PADT)](https://www.padtinc.com/2022/05/05/scripting-in-ansys-spaceclaim-part-1/)
* [Robust Workflows - Using SpaceClaim Scripting with Ansys Mechanical (Ozen)](https://blog.ozeninc.com/resources/spaceclaim-scripting-ansys-mechanical)
* [Scripting in Ansys SpaceClaim (CADFEM)](https://www.cadfem.net/gb/en/cadfem-informs/media-center/video/no-36-scripting-in-ansys-spaceclaim.html)

## Discovery

Ansys Discovery has journaling using Python scripting. It also has an Extensibility guide that uses .NET to create custom ribbons and tools. It's also possible to build custom Add-ins using C#.

* [Developer Portal Discovery Documentation](https://developer.ansys.com/docs/discovery)
* Includes links to variety of assistant resources as well
* [Customization in Ansys Discovery (White Paper)](https://www.ansys.com/en-gb/resource-center/white-paper/customization-ansys-discovery)

### Ansys Discovery training material

* [Scripting in Ansys Discovery Modeling (AIC)](https://innovationspace.ansys.com/product/scripting-in-ansys-discovery-modeling/)
* [Scripting in Ansys Discovery (ALH)](https://www.ansys.com/training-center/course-catalog/3d-design/scripting-in-ansys-discovery)
* [Advanced Scripting in Ansys Discovery (AIC)](https://innovationspace.ansys.com/product/advanced-scripting-in-ansys-discovery/)

### Non-Ansys Discovery training material

* [Scripting in Ansys Discovery (LEAP Australia)](https://www.youtube.com/watch?v=_JfIgFrEa64)
* [Python Scripting in Ansys Discovery (CADFEM)](https://blog.cadfem.net/en/python-scripting-in-ansys-discovery-only-for-nerds)
* [Automation with Ansys Discovery Scripting (CADFEM)](https://www.cadfem.net/gb/en/shop/professional-development/training-elearning/trending-topics/automation-with-ansys-discovery-scripting-18169.html)
14 changes: 14 additions & 0 deletions Markdown/developer_product_guide/Acoustics_Analysis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Acoustics Analysis

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding an introduction would help users.

## Sound

* [Ansys Sound for developers](https://developer.ansys.com/docs/sound)
* [PyAnsys Sound (PyAnsys)](https://sound.docs.pyansys.com/version/stable/)

Sound APIs for Active Sound Design for Electric Vehicles (ASDforEV), Car Sound Simulator (CSS), and Virtual Reality Sound (VRS) rely on the Open Sound Control (OSC) protocol, which is delivered over User Datagram Protocol (UDP). This means that these APIs are independent of the operating system and language, even if Ansys Sound is only available on Windows.

PyAnsys Sound APIs are available for Windows and Linux in Python. Note that the DPF server and DPF Sound plugin must run under Windows, and the client (the API) is available for both Linux and Windows.

### Ansys Sound training material

* [Introduction to PyAnsys Sound](https://www.youtube.com/watch?v=iJqGtOdzEyY)
7 changes: 7 additions & 0 deletions Markdown/developer_product_guide/Ansys_Additive_Solutions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Ansys Additive Solutions

## Ansys Additive Suite

The Ansys Additive server is distributed with the Additive option of the Structures package in the Ansys unified installation.

[PyAdditive Docs (PyAnsys)](https://additive.docs.pyansys.com/version/stable/)
33 changes: 33 additions & 0 deletions Markdown/developer_product_guide/Autonomous_Vehicle_Simulation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Autonomous Vehicle Simulation

## AVxcelerate Autonomy

[AVxcelerate for developers](https://developer.ansys.com/docs/avxcelerate)

AVxcelerate Autonomy APIs include several REST APIs and the Simulation Framework.

AVxcelerate Simulation Framework library is available for Linux in C++.

* Explore & Analyze REST API
* Scenario manager REST API
* SUT Configuration Service REST API
* Simulation Framework

## AVxcelerate Sensors

[AVxcelerate for developers](https://developer.ansys.com/docs/avxcelerate)

AVxcellerate Sensors APIs consist of several REST and gRPC APIs.

AVxcelerate Sensors APIs and libraries are available for Windows and Linux in all languages compatible with the gRPC framework.

* Sensors REST API
* Sensor Layouts REST API
* Lighting Systems REST API
* Sensors Simulator API
* Asset Preparation API

## AVxcelerate Headlamp

AVxcelerate Headlamp measures are available through a C++ API, Ansys SCADE connector or MATLAB Simulink toolbox, to allow
quantified detailed analysis on several lighting configurations and scenarios.
13 changes: 13 additions & 0 deletions Markdown/developer_product_guide/Cloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Cloud

## Cloud Direct

There are no developer tools available at this time.

## Ansys Gateway Powered by AWS

There are no developer tools available at this time.

## Access on Microsoft Azure

There are no Ansys developer tools available at this time.
39 changes: 39 additions & 0 deletions Markdown/developer_product_guide/Connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Connect

## optiSLang

* [optiSLang for developers](https://developer.ansys.com/docs/optislang)
* [PyOptiSLang Docs (PyAnsys)](https://optislang.docs.pyansys.com/)

optiSLang APIs and libraries are available for Windows and Linux in:

* Python
* C
* C++
* Lua
* Remote protocol

as well as in the form of the OSS PyAnsys library PyOptiSLang.

### Ansys optiSLang training material

* [Ansys optiSLang Getting Started](https://www.ansys.com/training-center/course-catalog/connect/ansys-optislang-getting-started#tab1-4)

## System Architecture Modeler

There are no developer tools available at this time.

## Minerva

Minerva has the Minerva Transfer Client which gives access to the Minerva SDK.

* [Is there a Python client library for interacting with Minerva?](https://discuss.ansys.com/discussion/2741/is-there-a-python-client-library-for-interacting-with-minerva)

## ModelCenter

[PyModelCenter Docs (PyAnsys)](https://modelcenter.docs.pyansys.com/version/stable/)

### Ansys Model Center training material

* [Ansys ModelCenter Automate and Integrate: Advanced](https://www.ansys.com/training-center/course-catalog/connect/ansys-modelcenter-automate-and-integrate-advanced#tab1-4)

Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Digital Mission Engineering (DME)

Ansys Government Initiatives (AGI) category.

* [AGI GitHub](https://github.com/AnalyticalGraphicsInc)

## Systems Tool Kit (STK)

* [Ansys STK](https://www.agi.com/new-stk)
* [STK Python Programmer's Guide](https://help.agi.com/stkdevkit/index.htm#python/pythonProgrammingGuide.htm?TocPath=Development%2520Environments%257CSTK%2520Python%2520API%257CProgrammer%25E2%2580%2599s%2520Guide%257C_____0)
* [STK Java API](https://help.agi.com/stkdevkit/index.htm#java/jdkOverview.htm?TocPath=Development%2520Environments%257CSTK%2520Java%2520API%257C_____0)

### Ansys STK training material

* [Ansys AGI Training & Certification (AGI)](https://www.agi.com/Training-and-Certification)
* [Python and SssssssTK! (AGI)](https://www.agi.com/tech-tips/Python-and-SssssssTK)
* [Lesson 16-2 Integrating STK With Python Using Jupyter Notebooks (AGI)](https://www.youtube.com/watch?v=uaVVzpRDg3s)

## DME Component libraries

Ansys DME Component Libraries can be used with Python through the use of [Pythonnet](https://pythonnet.github.io/) and also with MATLAB.

## Ansys DME Component libraries training material

* [Using DME Component Libraries with Python](https://help.agi.com/STKComponents/html/Python.htm)
* [Using DME Component Libraries with Matlab](https://help.agi.com/STKComponents/html/Matlab.htm)

## Orbit Determination Tool Kit (ODTK)

Interact with the Ansys Orbit Determination Tool Kit through scripts APIs and plugins.

* [Integrating With ODTK](https://help.agi.com/odtk/#od/odtkIntegratingTop.htm?TocPath=Integrating%2520with%2520ODTK%257C_____0)

[https://www.agi.com/blog/2022/04/customize-odtk-reports-with-python-and-pandas](https://www.agi.com/blog/2022/04/customize-odtk-reports-with-python-and-pandas)

## RF Channel Modeler

RF Channel Modeler has a client library that is available with bindings for .NET (C#), Python, and Native C++.

[RF Channel Model components](https://help.agi.com/stkdevkit/index.htm#DocX/AgStkRfcmObjectsLib_P.html?TocPath=Library%2520Reference%257CSTK%2520Object%2520Model%257CSTK%2520RF%2520Channel%2520Modeler%257C_____0)
12 changes: 12 additions & 0 deletions Markdown/developer_product_guide/Digital_Twin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Digital Twin

## Twin Builder/Twin Deployer+

Formerly known as "Simplorer." Includes journaling in the form of Python or Visual Basic scripting and a PyAnsys library, PyTwin.

* [PyTwin Documentation (PyAnsys)](https://twin.docs.pyansys.com/)

### Ansys Twin Builder training material

* [Boost your Ansys Digital Twin with PyAnsys: Learn How](https://www.ansys.com/en-gb/webinars/boost-your-ansys-digital-twin-with-pyansys-learn-how)

33 changes: 33 additions & 0 deletions Markdown/developer_product_guide/Embedded_Software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Embedded Software

## Scade One

Scade One is the new generation of SCADE (see below). In the Scade One environment you use the swan language. Scade One also has a PyAnsys OSS Python library called PyScadeOne and a developer portal landing page as well.

- [Scade One for Developers](https://developer.ansys.com/docs/scade-one)
- [PyScadeOne](https://github.com/ansys/pyscadeone)
- [PyScadeOne docs](https://scadeone.docs.pyansys.com/)

## SCADE

[SCADE for developers](https://developer.ansys.com/docs/scade)

The SCADE environment includes an API, a native language, and operator libraries. In addition there is an assortment of SCADE projects available to assist in your SCADE work. This includes SCADE API Tools which is an OSS PyAnsys library.

- [Ansys SCADE API Tools (PyAnsys)](https://apitools.scade.docs.pyansys.com/)
- [scade-guitools](https://github.com/ansys/scade-guitools)
- [scade-wux](https://github.com/ansys/scade-wux)
- [scade-python-wrapper](https://github.com/ansys/scade-python-wrapper)
- [scade-pyhg](https://github.com/ansys/scade-pyhg)
- [scade-actions](https://github.com/ansys/scade-actions)

### Ansys SCADE training material

* [Introduction to Ansys SCADE Suite (ALH)](https://www.ansys.com/training-center/course-catalog/embedded-software/introduction-to-ansys-scade-suite)
* [Ansys SCADE Suite Extending Capabilities by Python Scripts (ALH)](https://www.ansys.com/training-center/course-catalog/embedded-software/ansys-scade-suite-extending-capabilities-by-python-scripts)
* [Using the SCADE Python APIs from your favorite IDE (AIC)](https://innovationspace.ansys.com/knowledge/forums/topic/using-the-scade-python-apis-from-your-favorite-ide/)

### Non-Ansys SCADE training material

* [Developing Safety-Critical Embedded Software Using Ansys SCADE (CADFEM)](https://www.cadfem.net/en/shop/professional-development/training-elearning/trending-topics/developing-safety-critical-embedded-software-using-ansys-scade-14440.html)

14 changes: 14 additions & 0 deletions Markdown/developer_product_guide/Safety_Analysis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Safety Analysis

## Medini Analyze

Ansys medini utilizes multiple query and expression languages (OCL, AQL), and supports automation interfaces controlled with embedded JavaScript. The foundation for all expression and scripting languages are Ecore (EMF) based metamodels.

* [medini analyze Scripting and API Documentation](https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/medini/v251/en/medini_analyze_scripting/medini_analyze_scripting.html)
* You must be logged in with Ansys SSO/be a customer to access this material
* [medini analyze Metamodel Documentation](https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/medini/v251/en/medini_analyze_metamodel/medini_analyze_metamodel.html)
* You must be logged in with Ansys SSO/be a customer to access this material

## Digital Safety Manager

There are no developer tools available at this time.
133 changes: 133 additions & 0 deletions Markdown/developer_product_guide/electronics_and_semiconductors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Electronics and Semiconductors

Unlike other Ansys products, Ansys exposes many of its electronics and semiconductor products through Ansys Electronics Desktop (AEDT). The list below marks products accessible through AEDT with `*`. Products available both through AEDT and as standalone applications are marked with `+`.

## Electronics Desktop

The AEDT platform includes ACT Python scripting (including journaling) as well as the PyAEDT and PyEDB (Ansys Electronics Database) PyAnsys libraries. There has also been Visual Basic Scripting available alongside IronPython and CPython historically.

* [PyAEDT (PyAnsys)](https://aedt.docs.pyansys.com/)
* HFSS and HFSS 3D Layout
* Icepak
* Maxwell 2D, Maxwell 3D, and RMXprt
* 2D Extractor and Q3D Extractor
* Mechanical
* Nexxim
* EDB
* Twin Builder
* [PyEDB (PyAnsys)](https://edb.docs.pyansys.com/)
* EDB
* HFSS 3D Layout
* Icepak

There is also the Magnet Segmentation Toolkit which operates alongside PyAEDT to provide automation of the segmentation and skew of inner rotor interior permanent magnet and surface permanent magnet motors.

* [Magnet Segmentation Toolkit (PyAnsys)](https://magnet.segmentation.toolkit.docs.pyansys.com/version/stable/index.html)

### AEDT training material

* [Ansys Electronics Desktop Automation with PyAEDT Getting Started (ALH)](https://www.ansys.com/training-center/course-catalog/electronics/ansys-electronics-desktop-automation-with-pyeadt-getting-started)
* [Introduction to PyAEDT](https://developer.ansys.com/blog/introduction-pyaedt)
* [PyAnsys Training: Overview of PyAEDT](https://www.youtube.com/watch?v=yFUboNyJeGk)
* [PyAnsys Training: PyAEDT Examples and Use Cases](https://www.youtube.com/watch?v=MnACOZ1Axd4)

### Non-Ansys AEDT training material

* [PyAEDT: Introduction to the Ansys Electronics Desktop API (Ozen)](https://blog.ozeninc.com/resources/pyansys-introduction-to-the-electronics-desktop-api)

## MotorCAD

* [PyMotorCAD (PyAnsys)](https://motorcad.docs.pyansys.com/)

## ConceptEV

* [ConceptEV REST API](https://conceptev.ansys.com/api/docs)
* [PyConceptEV (PyAnsys)](https://conceptev.docs.pyansys.com/)

## NuHertz Filter Solutions+

See Electronics Desktop.

## Perceive EM

Ansys Perceive EM simulation software is a real-time, dynamic electromagnetic wave simulation solver API that supports many applications, including large-scale radar and wireless systems, with seamless digital twin integration. The Perceive EM API comes with C++ and Python bindings.

## EMC Plus

There are no developer tools available at this time.

## PowerArtist

There are no developer tools available at this time.

## Redhawk-SC

RedHawkSC and TotemSC have a pythonic library known as PySeascape that's available as part of PyAnsys which provides a remotable interface to these two products.

[PySeascape (PyAnsys)](https://seascape.docs.pyansys.com/version/stable/)

## Totem

See [Redhawk-SC](#Redhawk-SC) and PySeascape.

## VeloceRF

There are no developer tools available at this time.

## Pathfinder

There are no developer tools available at this time.

## Clock FX

There are no developer tools available at this time.

## RaptorH

There are no developer tools available at this time.

## RaptorX

There are no developer tools available at this time.

## Exalto

There are no developer tools available at this time.

## Q3D Extractor*

See Electronics Desktop.

## Icepak*

See Electronics Desktop.

## HFSS*/HFSS-IC*

IC stands for "Integrated Circuit."

See Electronics Desktop.

## RaptorQu

There are no developer tools available at this time.

## SIwave+

See Electronics Desktop. Otherwise contains IronPython scripting.

## Maxwell*

See Electronics Desktop.

## ParagonX

Has a GUI mode and a batch mode that uses Python scripting. Script with Python in an internal (CPython) interpreter that comes with multiple pre-installed libraries for interfacing with the product.

## PEmag+

See Electronics Desktop.

## PExprt+

See Electronics Desktop.
Loading