ansys-api-sherlock 0.1.13__tar.gz

ansys-api-sherlock-0.1.13/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ANSYS, Inc. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ansys-api-sherlock-0.1.13/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.1
+Name: ansys-api-sherlock
+Version: 0.1.13
+Summary: Autogenerated python gRPC interface package for ansys-api-sherlock, built on 14:30:26 on 20 April 2023
+Home-page: https://github.com/ansys/ansys-api-sherlock
+Author: ANSYS, Inc.
+Author-email: support@ansys.com
+License: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+### ansys-api-sherlock gRPC Interface Package
+
+This Python package contains the auto-generated gRPC Python interface files for
+Sherlock.
+
+
+#### Installation
+
+Provided that these wheels have been published to public PyPI, they can be
+installed with:
+
+```
+pip install ansys-api-sherlock
+```
+
+Otherwise, see the
+
+
+#### Build
+
+To build the gRPC packages, run:
+
+```
+pip install build
+python -m build
+```
+
+This will create both the source distribution containing just the protofiles
+along with the wheel containing the protofiles and build Python interface
+files.
+
+Note that the interface files are identical regardless of the version of Python
+used to generate them, but the last pre-built wheel for ``grpcio~=1.17`` was
+Python 3.7, so to improve your build time, use Python 3.7 when building the
+wheel.
+
+
+#### Manual Deployment
+
+After building the packages, manually deploy them with:
+
+```
+pip install twine
+twine upload dist/*
+```
+
+Note that this is automatically done through CI/CD.
+
+
+#### Automatic Deployment
+
+This repository contains GitHub CI/CD that enables the automatic building of
+source and wheel packages for these gRPC Python interface files. By default,
+these are built on PRs, the main branch, and on tags when pushing. Artifacts
+are uploaded for each PR.
+
+To publicly release wheels to PyPI, ensure your branch is up-to-date and then
+push tags. For example, for the version ``v0.5.0``.
+
+```bash
+git tag v0.5.0
+git push --tags
+```

ansys-api-sherlock-0.1.13/README.md

@@ -0,0 +1,63 @@
+### ansys-api-sherlock gRPC Interface Package
+
+This Python package contains the auto-generated gRPC Python interface files for
+Sherlock.
+
+
+#### Installation
+
+Provided that these wheels have been published to public PyPI, they can be
+installed with:
+
+```
+pip install ansys-api-sherlock
+```
+
+Otherwise, see the
+
+
+#### Build
+
+To build the gRPC packages, run:
+
+```
+pip install build
+python -m build
+```
+
+This will create both the source distribution containing just the protofiles
+along with the wheel containing the protofiles and build Python interface
+files.
+
+Note that the interface files are identical regardless of the version of Python
+used to generate them, but the last pre-built wheel for ``grpcio~=1.17`` was
+Python 3.7, so to improve your build time, use Python 3.7 when building the
+wheel.
+
+
+#### Manual Deployment
+
+After building the packages, manually deploy them with:
+
+```
+pip install twine
+twine upload dist/*
+```
+
+Note that this is automatically done through CI/CD.
+
+
+#### Automatic Deployment
+
+This repository contains GitHub CI/CD that enables the automatic building of
+source and wheel packages for these gRPC Python interface files. By default,
+these are built on PRs, the main branch, and on tags when pushing. Artifacts
+are uploaded for each PR.
+
+To publicly release wheels to PyPI, ensure your branch is up-to-date and then
+push tags. For example, for the version ``v0.5.0``.
+
+```bash
+git tag v0.5.0
+git push --tags
+```

ansys-api-sherlock-0.1.13/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools >= 42.0.0", "wheel", "ansys_tools_protoc_helper"]
+build-backend = "setuptools.build_meta:__legacy__"

ansys-api-sherlock-0.1.13/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ansys-api-sherlock-0.1.13/setup.py

@@ -0,0 +1,50 @@
+"""Installation file for the ansys-api-sherlock package"""
+
+import os
+from datetime import datetime
+
+import setuptools
+
+from ansys.tools.protoc_helper import CMDCLASS_OVERRIDE
+
+# Get the long description from the README file
+HERE = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(HERE, "README.md"), encoding="utf-8") as f:
+    long_description = f.read()
+
+product = "sherlock"
+library = ""
+package_info = ["ansys", "api", product, library, "v0"]
+with open(os.path.join(HERE, "src", "ansys", "api", product, library, "VERSION"), encoding="utf-8") as f:
+    version = f.read().strip()
+
+package_name = "ansys-api-sherlock"
+dot_package_name = '.'.join(filter(None, package_info))
+
+description = f"Autogenerated python gRPC interface package for {package_name}, built on {datetime.now().strftime('%H:%M:%S on %d %B %Y')}"
+
+if __name__ == "__main__":
+    setuptools.setup(
+        name=package_name,
+        version=version,
+        author="ANSYS, Inc.",
+        author_email='support@ansys.com',
+        description=description,
+        long_description=long_description,
+        long_description_content_type='text/markdown',
+        url=f"https://github.com/ansys/{package_name}",
+        license="MIT",
+        python_requires=">=3.7",
+        install_requires=["grpcio~=1.17", "protobuf~=3.19"],
+        package_dir = {"": "src"},
+        packages=setuptools.find_namespace_packages("src", include=("ansys.*",)),
+        package_data={
+            "": ["*.proto", "*.pyi", "py.typed", "VERSION"],
+        },
+        entry_points={
+            "ansys.tools.protoc_helper.proto_provider": [
+                f"{dot_package_name}={dot_package_name}"
+            ],
+        },
+        cmdclass=CMDCLASS_OVERRIDE
+    )

ansys-api-sherlock-0.1.13/src/ansys/api/sherlock/VERSION

@@ -0,0 +1 @@
+0.1.13

ansys-api-sherlock-0.1.13/src/ansys/api/sherlock/__init__.py

@@ -0,0 +1,8 @@
+"""Autogenerated Python gRPC interface package for ansys-api-sherlock."""
+
+import pathlib
+
+__all__ = ["__version__"]
+
+with open(pathlib.Path(__file__).parent / "VERSION", encoding="utf-8") as f:
+    __version__ = f.read().strip()

ansys-api-sherlock-0.1.13/src/ansys/api/sherlock/v0/SherlockAnalysisService.proto

@@ -0,0 +1,150 @@
+// @Copyright 2023 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
+syntax = "proto3";
+
+import "ansys/api/sherlock/v0/SherlockCommonService.proto";
+
+option java_package = "sherlock.grpc";
+option java_outer_classname = "SherlockAnalysisServiceProto";
+
+enum ModelSource {
+  UNKNOWN			= 0;	// Default enum to catch invalid source
+  GENERATED			= 1;	// Generated analysis model source
+  STRAIN_MAP		= 2;	// Strain map analysis model source
+}
+
+/**
+  * Request to run one or more Sherlock analysis given the project path, CCA name, analyses, lifecycle phases and events.
+  */
+message RunAnalysisRequest {
+  string project							= 1;	// Sherlock project name.
+  string ccaName							= 2;	// The CCA name.
+
+  message Analysis { 
+    enum AnalysisType {
+      reserved 6;
+      UNKNOWN	 			= 0;	// Default enum to catch invalid analysis.
+      NaturalFreq 			= 1;	// Enum for the Natural Frequency analysis.
+      HarmonicVibe 			= 2;	// Enum for the Harmonic Vibe analysis.
+      ICTAnalysis 			= 3;	// Enum for the ICA analysis.
+      MechanicalShock 		= 4;	// Enum for the Mechanical Shock analysis.
+      RandomVibe 			= 5;	// Enum for the Random Vibe analysis.
+      ComponentFailureMode	= 7;	// Enum for the Component Failure Mechanism analysis.
+      DFMEAModule			= 8;	// Enum for the DFMEA analysis.
+      PTHFatigue			= 9;	// Enum for the PTH Fatigue analysis.
+      PartValidation		= 10;	// Enum for the Part Validation analysis.
+      SemiconductorWearout	= 11;	// Enum for the Semiconductor Wearout analysis.
+      SolderJointFatigue	= 12;	// Enum for the Solder Fatigue analysis.
+      ThermalDerating		= 13;	// Enum for the Thermal Derating analysis.
+      ThermalMech			= 14;	// Enum for the Thermal Mech analysis.
+    }
+    AnalysisType type 				= 1;
+    message Phase {
+      string name			= 1;		// Life cycle phase name.
+      message Event {	
+        string name = 1;				// Life cycle event name.
+      }
+      repeated Event events	= 2;
+    }
+    repeated Phase phases			= 2;
+  }
+
+  repeated Analysis analyses				= 3;
+}
+
+/**
+ * Request to list the valid Random Vibe input fields for the provided model source and user configuration.
+ */
+message GetRandomVibeInputFieldsRequest {
+  optional ModelSource modelSource = 1;	// Optional model source. Default: GENERATED
+}
+
+message GetRandomVibeInputFieldsResponse {
+  repeated string fieldName = 1;
+}
+
+message UpdateRandomVibePropsRequest {
+  string project = 1;									// Project name.
+  string ccaName = 2;									// CCA name.
+  optional string randomVibeDamping = 3;				// Modal Damping Ratio(s).
+  optional double naturalFreqMin = 4;					// Min Frequency. For NX Nastran analysis only.
+  optional string naturalFreqMinUnits = 5;				// Min Frequency units. For NX Nastran analysis only.
+  optional double naturalFreqMax = 6;					// Max Frequency. For NX Nastran analysis only.
+  optional string naturalFreqMaxUnits = 7;				// Max Frequency units. For NX Nastran analysis only.
+  optional double analysisTemp = 8;						// Temperature.
+  optional string analysisTempUnits = 9; 				// Temperature units.
+  optional bool partValidationEnabled = 10;				// Part Validation.
+  optional string forceModelRebuild = 11;				// Model Creation. Valid values are "FORCE" or "AUTO"
+  optional bool reuseModalAnalysis = 12;				// Reuse Natural Frequency. For NX Nastran analysis only.
+  optional bool performNFFreqRangeCheck = 13;			// Frequency Range Check. For NX Nastran analysis only.
+  optional bool requireMaterialAssignmentEnabled = 14;	// Require Material Assignment.
+  optional ModelSource modelSource = 15;				// Optional model source. Default: GENERATED
+  optional string strainMapNaturalFreqs = 16;			// Comma-separated list of natural frequencies for strain map analysis.
+}
+
+
+message GetNaturalFrequencyInputFieldsRequest {
+}
+
+message GetNaturalFrequencyInputFieldsResponse {
+  repeated string fieldName = 1;
+}
+
+message UpdateNaturalFrequencyPropsRequest {
+  string project = 1;							// Project name.
+  string ccaName = 2;							// CCA name.
+  int32 naturalFreqCount = 3;					// NF Result Count.
+  double naturalFreqMin = 4;					// Min Frequency.
+  string naturalFreqMinUnits = 5;				// Min Frequency units (HZ, KHZ, MHZ, or GHZ).
+  double naturalFreqMax = 6;					// Max Frequency.
+  string naturalFreqMaxUnits = 7;				// Max Frequency units (HZ, KHZ, MHZ, or GHZ).
+  bool partValidationEnabled = 8;				// Part Validation.
+  bool requireMaterialAssignmentEnabled = 9;	// Require Material Assignment.
+  optional double analysisTemp = 10;			// Temperature.
+  optional string analysisTempUnits = 11; 		// Temperature units (C, F, or K).
+}
+
+/**
+  * Request to run Sherlock strain map analysis given the project name, CCA name, and strain maps.
+  */
+message RunStrainMapAnalysisRequest {
+  string project			= 1;	// Sherlock project name.
+  string ccaName			= 2;	// The CCA name of the main CCA for the analysis.
+
+  message StrainMapAnalysis { 
+    enum AnalysisType {
+      UNKNOWN	 	= 0;	// Default enum to catch invalid analysis.
+      RandomVibe 	= 1;	// Enum for the Random Vibe analysis.
+    }
+    AnalysisType type 		= 1;
+    message EventStrainMap {	
+	  string phaseName = 1;						// Life cycle phase name.
+	  string eventName = 2;						// Life cycle event name.
+	  string pcbSide = 3;						// PCB side for the strain map. Supported values are: TOP, BOTTOM.
+	  string strainMap = 4;						// Strain map assigned to the event.
+	  optional string subAssemblyName = 5;		// The name of the sub-assembly CCA to be assigned the strain map.
+    }
+    repeated EventStrainMap eventStrainMaps	= 2;
+  }
+
+  repeated StrainMapAnalysis strainMapAnalyses = 3;
+}
+
+service SherlockAnalysisService {
+  // Runs one or more Sherlock analysis.
+  rpc runAnalysis(RunAnalysisRequest) returns (ReturnCode);
+  
+  // Run Sherlock strain map analysis.
+  rpc runStrainMapAnalysis(RunStrainMapAnalysisRequest) returns (ReturnCode);
+  
+  // Returns the list of valid Random Vibe input fields for the provided model source and user configuration.
+  rpc getRandomVibeInputFields(GetRandomVibeInputFieldsRequest) returns (GetRandomVibeInputFieldsResponse);
+  
+  // Updates the analysis properties for Random Vibe analysis.
+  rpc updateRandomVibeProps(UpdateRandomVibePropsRequest) returns (ReturnCode);
+  
+  // Returns the list of valid Natural Frequency property fields given the user configuration.
+  rpc getNaturalFrequencyInputFields(GetNaturalFrequencyInputFieldsRequest) returns (GetNaturalFrequencyInputFieldsResponse);
+  
+  // Updates the analysis properties for Natural Frequency analysis.
+  rpc updateNaturalFrequencyProps(UpdateNaturalFrequencyPropsRequest) returns (ReturnCode);
+}

ansys-api-sherlock-0.1.13/src/ansys/api/sherlock/v0/SherlockCommonService.proto

@@ -0,0 +1,103 @@
+// © 2020 ANSYS, Inc.  Unauthorized use, distribution, or duplication is prohibited.
+syntax = "proto3";
+
+option java_package = "sherlock.grpc";
+option java_outer_classname = "SherlockCommonServiceProto";
+
+/**
+ * Status response of a message. A value of 0 indicates a successful request. 
+ */
+message ReturnCode {
+  int32 value = 1;		// Status code of response. A value of 0 indicates success.
+  string message = 2;	// Message indicating the status of response including any error.
+}
+
+/**
+ * Empty request to exit the gRPC connection.
+ */
+message ExitRequest {
+   bool closeSherlockClient = 1;	// If set to true, exits the Sherlock client if it is opened. Otherwise, just closes the gRPC connection.
+}
+
+/**
+ * Empty request to check if the gRPC connection is open.
+ */
+message HealthCheckRequest {
+}
+
+/**
+ * Represents whether the gRPC connection is open.
+ */
+message HealthCheckResponse {
+  enum ServingStatus {
+    UNKNOWN = 0;		// Indicates an unknown connection status.
+    SERVING = 1;		// Indicates the connection is up and server is listening.
+    NOT_SERVING = 2;	// Indicates connection with server is closed.
+  }
+  ServingStatus status = 1;
+  int32 port = 2;		// Listening port number on server.
+}
+
+message IsSherlockClientLoadingRequest {
+}
+
+/**
+  * Request for a list of valid units of the provided unit type.
+  */
+message ListUnitsRequest {
+  enum UnitType {
+    UNKNOWN = 0;				// Indicates an unknown unit type.
+    ACCEL_DENSITY = 1;			// Units used for acceleration density.
+    ACCELERATION = 2;			// Units used for acceleration.
+    AREA = 3;					// Units used for area.
+    BANDWIDTH = 4;				// Units used for bandwidth.
+    CAPACITANCE = 5;			// Units used for electrical capacitance.
+    CTE = 6;					// Units used for material CTE.
+    CURRENT = 7;				// Units used for electrical current.
+    DENSITY = 8;				// Units used for density.
+    DISP_DENSITY = 9;			// Units used for displacement density.
+    FORCE = 10;					// Units used for force.
+    FREQUENCY = 11;				// Units used for frequency.
+    INDUCTANCE = 12;			// Units used for inductance.
+    LENGTH = 13;				// Units used for length.
+    POWER = 14;					// Units used for electrical power.
+    RESISTANCE = 15;			// Units used for electrical resistance.
+    SIZE = 16;					// Units used for size.
+    SPECIFIC_HEAT = 17;			// Units used for specific heat.
+    STRAIN = 18;				// Units used for strain.
+    STRESS = 19;				// Units used for stress.
+    TEMPERATURE = 20;			// Units used for temperature.
+    THERMAL_CONDUCTIVITY = 21;	// Units used for thermal conductivity.
+    THERMAL_RESISTANCE = 22;	// Units used for thermal resistance.
+    TIME = 23;					// Units used for time.
+    VELOCITY = 24;				// Units used for velocity.
+    VELOCITY_DENSITY = 25;		// Units used for velocity density.
+    VOLTAGE = 26;				// Units used for electrical voltage.
+    VOLUME = 27;				// Units used for volume.
+    WEIGHT = 28;				// Units used for weight.
+  }
+  UnitType unitType = 1;	// Unit type to request valid units of.
+}
+
+/**
+  * Represents a list of valid units for the provided unit type.
+  */
+message ListUnitsResponse {
+  ReturnCode returnCode 	= 1;	// Status code of response.
+  repeated string units		= 2;	// List of valid units for the requested type.
+}
+
+service SherlockCommonService {
+
+  // Returns health status of gRPC server.
+  rpc check(HealthCheckRequest) returns (HealthCheckResponse);
+  
+  // Signals for gRPC connection to shutdown.
+  rpc exit(ExitRequest) returns (ReturnCode);
+  
+  // Check if SherlockClient is still loading.
+  rpc isSherlockClientLoading(IsSherlockClientLoadingRequest) returns (ReturnCode);
+  
+  // Returns a list of valid units of the provided unit type.
+  rpc listUnits(ListUnitsRequest) returns (ListUnitsResponse);
+}