dlubal.api 0.1.293714a1__py3-none-any.whl → 2.12.2__py3-none-any.whl

dlubal/api/rstab/types_for_wind_simulation/roughness_and_permeability_pb2.pyi

@@ -0,0 +1,81 @@
+from google.protobuf.internal import containers as _containers
+from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class RoughnessAndPermeability(_message.Message):
+    __slots__ = ("no", "user_defined_name_enabled", "name", "assigned_members", "assigned_visual_objects", "assigned_ifc_objects", "type_of_surface", "sand_grain_roughness_definition", "height_of_sand_grain_roughness", "roughness_constant", "darcy_coefficient", "inertial_coefficient", "porous_media_length_in_flow_direction", "comment", "id_for_export_import", "metadata_for_export_import")
+    class TypeOfSurface(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+        __slots__ = ()
+        TYPE_OF_SURFACE_SMOOTH: _ClassVar[RoughnessAndPermeability.TypeOfSurface]
+        TYPE_OF_SURFACE_PERMEABLE: _ClassVar[RoughnessAndPermeability.TypeOfSurface]
+        TYPE_OF_SURFACE_ROUGH: _ClassVar[RoughnessAndPermeability.TypeOfSurface]
+    TYPE_OF_SURFACE_SMOOTH: RoughnessAndPermeability.TypeOfSurface
+    TYPE_OF_SURFACE_PERMEABLE: RoughnessAndPermeability.TypeOfSurface
+    TYPE_OF_SURFACE_ROUGH: RoughnessAndPermeability.TypeOfSurface
+    class SandGrainRoughnessDefinition(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+        __slots__ = ()
+        SAND_GRAIN_ROUGHNESS_DEFINITION_MANUAL_DEFINITION: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_BRICKWORK: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_BRIGHT_STEEL: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_CAST_IRON: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_FINE_PAINT: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_GALVANISED_STEEL: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_GLASS: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_PLANED_WOOD: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_POLISHED_METAL: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_ROUGH_CONCRETE: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_ROUGH_SAWN_WOOD: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_RUST: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_SMOOTH_CONCRETE: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+        SAND_GRAIN_ROUGHNESS_DEFINITION_SPRAY_PAINT: _ClassVar[RoughnessAndPermeability.SandGrainRoughnessDefinition]
+    SAND_GRAIN_ROUGHNESS_DEFINITION_MANUAL_DEFINITION: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_BRICKWORK: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_BRIGHT_STEEL: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_CAST_IRON: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_FINE_PAINT: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_GALVANISED_STEEL: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_GLASS: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_PLANED_WOOD: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_POLISHED_METAL: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_ROUGH_CONCRETE: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_ROUGH_SAWN_WOOD: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_RUST: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_SMOOTH_CONCRETE: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    SAND_GRAIN_ROUGHNESS_DEFINITION_SPRAY_PAINT: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    NO_FIELD_NUMBER: _ClassVar[int]
+    USER_DEFINED_NAME_ENABLED_FIELD_NUMBER: _ClassVar[int]
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_MEMBERS_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_VISUAL_OBJECTS_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_IFC_OBJECTS_FIELD_NUMBER: _ClassVar[int]
+    TYPE_OF_SURFACE_FIELD_NUMBER: _ClassVar[int]
+    SAND_GRAIN_ROUGHNESS_DEFINITION_FIELD_NUMBER: _ClassVar[int]
+    HEIGHT_OF_SAND_GRAIN_ROUGHNESS_FIELD_NUMBER: _ClassVar[int]
+    ROUGHNESS_CONSTANT_FIELD_NUMBER: _ClassVar[int]
+    DARCY_COEFFICIENT_FIELD_NUMBER: _ClassVar[int]
+    INERTIAL_COEFFICIENT_FIELD_NUMBER: _ClassVar[int]
+    POROUS_MEDIA_LENGTH_IN_FLOW_DIRECTION_FIELD_NUMBER: _ClassVar[int]
+    COMMENT_FIELD_NUMBER: _ClassVar[int]
+    ID_FOR_EXPORT_IMPORT_FIELD_NUMBER: _ClassVar[int]
+    METADATA_FOR_EXPORT_IMPORT_FIELD_NUMBER: _ClassVar[int]
+    no: int
+    user_defined_name_enabled: bool
+    name: str
+    assigned_members: _containers.RepeatedScalarFieldContainer[int]
+    assigned_visual_objects: _containers.RepeatedScalarFieldContainer[int]
+    assigned_ifc_objects: _containers.RepeatedScalarFieldContainer[int]
+    type_of_surface: RoughnessAndPermeability.TypeOfSurface
+    sand_grain_roughness_definition: RoughnessAndPermeability.SandGrainRoughnessDefinition
+    height_of_sand_grain_roughness: float
+    roughness_constant: float
+    darcy_coefficient: float
+    inertial_coefficient: float
+    porous_media_length_in_flow_direction: float
+    comment: str
+    id_for_export_import: str
+    metadata_for_export_import: str
+    def __init__(self, no: _Optional[int] = ..., user_defined_name_enabled: bool = ..., name: _Optional[str] = ..., assigned_members: _Optional[_Iterable[int]] = ..., assigned_visual_objects: _Optional[_Iterable[int]] = ..., assigned_ifc_objects: _Optional[_Iterable[int]] = ..., type_of_surface: _Optional[_Union[RoughnessAndPermeability.TypeOfSurface, str]] = ..., sand_grain_roughness_definition: _Optional[_Union[RoughnessAndPermeability.SandGrainRoughnessDefinition, str]] = ..., height_of_sand_grain_roughness: _Optional[float] = ..., roughness_constant: _Optional[float] = ..., darcy_coefficient: _Optional[float] = ..., inertial_coefficient: _Optional[float] = ..., porous_media_length_in_flow_direction: _Optional[float] = ..., comment: _Optional[str] = ..., id_for_export_import: _Optional[str] = ..., metadata_for_export_import: _Optional[str] = ...) -> None: ...

dlubal/api/rstab/types_for_wind_simulation/shrink_wrapping_pb2.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: dlubal/api/rstab/types_for_wind_simulation/shrink_wrapping.proto
+# Protobuf Python Version: 5.28.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    5,
+    28,
+    1,
+    '',
+    'dlubal/api/rstab/types_for_wind_simulation/shrink_wrapping.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n@dlubal/api/rstab/types_for_wind_simulation/shrink_wrapping.proto\x12*dlubal.api.rstab.types_for_wind_simulation\"\xff\t\n\x0eShrinkWrapping\x12\x0f\n\x02no\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12&\n\x19user_defined_name_enabled\x18\x02 \x01(\x08H\x01\x88\x01\x01\x12\x11\n\x04name\x18\x03 \x01(\tH\x02\x88\x01\x01\x12\x18\n\x10\x61ssigned_members\x18\x04 \x03(\x05\x12\x1f\n\x17\x61ssigned_visual_objects\x18\x05 \x03(\x05\x12\x1c\n\x14\x61ssigned_ifc_objects\x18\x06 \x03(\x05\x12z\n\x19simplification_defined_by\x18\x07 \x01(\x0e\x32R.dlubal.api.rstab.types_for_wind_simulation.ShrinkWrapping.SimplificationDefinedByH\x03\x88\x01\x01\x12\x1c\n\x0flevel_of_detail\x18\x08 \x01(\x05H\x04\x88\x01\x01\x12\x18\n\x0b\x64\x65tail_size\x18\t \x01(\x01H\x05\x88\x01\x01\x12}\n\x1bsmall_openings_closure_type\x18\n \x01(\x0e\x32S.dlubal.api.rstab.types_for_wind_simulation.ShrinkWrapping.SmallOpeningsClosureTypeH\x06\x88\x01\x01\x12\x30\n#closure_relative_to_model_parameter\x18\x0b \x01(\x01H\x07\x88\x01\x01\x12\x1e\n\x11\x63losure_real_size\x18\x0c \x01(\x01H\x08\x88\x01\x01\x12/\n\"orient_normals_for_surface_results\x18\r \x01(\x08H\t\x88\x01\x01\x12\x14\n\x07\x63omment\x18\x0e \x01(\tH\n\x88\x01\x01\x12!\n\x14id_for_export_import\x18\x0f \x01(\tH\x0b\x88\x01\x01\x12\'\n\x1ametadata_for_export_import\x18\x10 \x01(\tH\x0c\x88\x01\x01\"t\n\x17SimplificationDefinedBy\x12.\n*SIMPLIFICATION_DEFINED_BY_LEVEL_OF_DETAILS\x10\x00\x12)\n%SIMPLIFICATION_DEFINED_BY_DETAIL_SIZE\x10\x01\"\x80\x01\n\x18SmallOpeningsClosureType\x12\x39\n5SMALL_OPENINGS_CLOSURE_TYPE_PERCENT_OF_MODEL_DIAMETER\x10\x00\x12)\n%SMALL_OPENINGS_CLOSURE_TYPE_REAL_SIZE\x10\x01\x42\x05\n\x03_noB\x1c\n\x1a_user_defined_name_enabledB\x07\n\x05_nameB\x1c\n\x1a_simplification_defined_byB\x12\n\x10_level_of_detailB\x0e\n\x0c_detail_sizeB\x1e\n\x1c_small_openings_closure_typeB&\n$_closure_relative_to_model_parameterB\x14\n\x12_closure_real_sizeB%\n#_orient_normals_for_surface_resultsB\n\n\x08_commentB\x17\n\x15_id_for_export_importB\x1d\n\x1b_metadata_for_export_importb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'dlubal.api.rstab.types_for_wind_simulation.shrink_wrapping_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_SHRINKWRAPPING']._serialized_start=113
+  _globals['_SHRINKWRAPPING']._serialized_end=1392
+  _globals['_SHRINKWRAPPING_SIMPLIFICATIONDEFINEDBY']._serialized_start=832
+  _globals['_SHRINKWRAPPING_SIMPLIFICATIONDEFINEDBY']._serialized_end=948
+  _globals['_SHRINKWRAPPING_SMALLOPENINGSCLOSURETYPE']._serialized_start=951
+  _globals['_SHRINKWRAPPING_SMALLOPENINGSCLOSURETYPE']._serialized_end=1079
+# @@protoc_insertion_point(module_scope)

dlubal/api/rstab/types_for_wind_simulation/shrink_wrapping_pb2.pyi

@@ -0,0 +1,55 @@
+from google.protobuf.internal import containers as _containers
+from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class ShrinkWrapping(_message.Message):
+    __slots__ = ("no", "user_defined_name_enabled", "name", "assigned_members", "assigned_visual_objects", "assigned_ifc_objects", "simplification_defined_by", "level_of_detail", "detail_size", "small_openings_closure_type", "closure_relative_to_model_parameter", "closure_real_size", "orient_normals_for_surface_results", "comment", "id_for_export_import", "metadata_for_export_import")
+    class SimplificationDefinedBy(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+        __slots__ = ()
+        SIMPLIFICATION_DEFINED_BY_LEVEL_OF_DETAILS: _ClassVar[ShrinkWrapping.SimplificationDefinedBy]
+        SIMPLIFICATION_DEFINED_BY_DETAIL_SIZE: _ClassVar[ShrinkWrapping.SimplificationDefinedBy]
+    SIMPLIFICATION_DEFINED_BY_LEVEL_OF_DETAILS: ShrinkWrapping.SimplificationDefinedBy
+    SIMPLIFICATION_DEFINED_BY_DETAIL_SIZE: ShrinkWrapping.SimplificationDefinedBy
+    class SmallOpeningsClosureType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+        __slots__ = ()
+        SMALL_OPENINGS_CLOSURE_TYPE_PERCENT_OF_MODEL_DIAMETER: _ClassVar[ShrinkWrapping.SmallOpeningsClosureType]
+        SMALL_OPENINGS_CLOSURE_TYPE_REAL_SIZE: _ClassVar[ShrinkWrapping.SmallOpeningsClosureType]
+    SMALL_OPENINGS_CLOSURE_TYPE_PERCENT_OF_MODEL_DIAMETER: ShrinkWrapping.SmallOpeningsClosureType
+    SMALL_OPENINGS_CLOSURE_TYPE_REAL_SIZE: ShrinkWrapping.SmallOpeningsClosureType
+    NO_FIELD_NUMBER: _ClassVar[int]
+    USER_DEFINED_NAME_ENABLED_FIELD_NUMBER: _ClassVar[int]
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_MEMBERS_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_VISUAL_OBJECTS_FIELD_NUMBER: _ClassVar[int]
+    ASSIGNED_IFC_OBJECTS_FIELD_NUMBER: _ClassVar[int]
+    SIMPLIFICATION_DEFINED_BY_FIELD_NUMBER: _ClassVar[int]
+    LEVEL_OF_DETAIL_FIELD_NUMBER: _ClassVar[int]
+    DETAIL_SIZE_FIELD_NUMBER: _ClassVar[int]
+    SMALL_OPENINGS_CLOSURE_TYPE_FIELD_NUMBER: _ClassVar[int]
+    CLOSURE_RELATIVE_TO_MODEL_PARAMETER_FIELD_NUMBER: _ClassVar[int]
+    CLOSURE_REAL_SIZE_FIELD_NUMBER: _ClassVar[int]
+    ORIENT_NORMALS_FOR_SURFACE_RESULTS_FIELD_NUMBER: _ClassVar[int]
+    COMMENT_FIELD_NUMBER: _ClassVar[int]
+    ID_FOR_EXPORT_IMPORT_FIELD_NUMBER: _ClassVar[int]
+    METADATA_FOR_EXPORT_IMPORT_FIELD_NUMBER: _ClassVar[int]
+    no: int
+    user_defined_name_enabled: bool
+    name: str
+    assigned_members: _containers.RepeatedScalarFieldContainer[int]
+    assigned_visual_objects: _containers.RepeatedScalarFieldContainer[int]
+    assigned_ifc_objects: _containers.RepeatedScalarFieldContainer[int]
+    simplification_defined_by: ShrinkWrapping.SimplificationDefinedBy
+    level_of_detail: int
+    detail_size: float
+    small_openings_closure_type: ShrinkWrapping.SmallOpeningsClosureType
+    closure_relative_to_model_parameter: float
+    closure_real_size: float
+    orient_normals_for_surface_results: bool
+    comment: str
+    id_for_export_import: str
+    metadata_for_export_import: str
+    def __init__(self, no: _Optional[int] = ..., user_defined_name_enabled: bool = ..., name: _Optional[str] = ..., assigned_members: _Optional[_Iterable[int]] = ..., assigned_visual_objects: _Optional[_Iterable[int]] = ..., assigned_ifc_objects: _Optional[_Iterable[int]] = ..., simplification_defined_by: _Optional[_Union[ShrinkWrapping.SimplificationDefinedBy, str]] = ..., level_of_detail: _Optional[int] = ..., detail_size: _Optional[float] = ..., small_openings_closure_type: _Optional[_Union[ShrinkWrapping.SmallOpeningsClosureType, str]] = ..., closure_relative_to_model_parameter: _Optional[float] = ..., closure_real_size: _Optional[float] = ..., orient_normals_for_surface_results: bool = ..., comment: _Optional[str] = ..., id_for_export_import: _Optional[str] = ..., metadata_for_export_import: _Optional[str] = ...) -> None: ...

dlubal_api-2.12.2.dist-info/METADATA

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: dlubal.api
+Version: 2.12.2
+Summary: Python Client Library for Dlubal Software APIs powered by gRPC
+Author-email: Dlubal Software <api@dlubal.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: grpcio==1.68.0
+Requires-Dist: grpcio-tools==1.68.0
+Requires-Dist: pandas==2.2.3
+
+# Dlubal API
+
+![PyPI](https://img.shields.io/pypi/v/dlubal.api)
+![Python](https://img.shields.io/badge/Python-3.7%2B-blue)
+![License](https://img.shields.io/badge/License-Proprietary-red)
+
+## Compatibility
+
+This package version is fully compatible with the following **Dlubal App version**:
+
+✅ **X.12.0002.269.b37c612fd36**
+
+## Overview
+The `dlubal.api` package is the next-generation Python client library for interacting with Dlubal Software APIs, leveraging modern **gRPC technology** to deliver high-speed communication, scalability, and improved performance. This API enables **seamless automation** and **remote access** to Dlubal software **RFEM 6** and **RSTAB 9**, with plans for near-future support for additional products in the Dlubal portfolio.
+
+---
+
+## Installation
+
+Ensure you have **Python 3.10+** installed. Then, install the package via **pip**:
+
+```sh
+pip install dlubal.api
+```
+
+For additional installation options, refer to the **official documentation**.
+
+---
+
+## Quick Start
+
+### Authentication & Authorization
+To use the API, you need:
+- **API Key**: Obtainable via your **Extranet | API & Cloud** dashboard.
+- **API Subscription**: [Dlubal API Subscriptions](https://www.dlubal.com/en/webshop/online-service)
+
+---
+
+### Example Usage
+```python
+from dlubal.api import rfem
+
+with rfem.Application(api_key="your_api_key") as rfem_app:
+    # Example API call
+    rfem_app.create_model("MyModel")
+    rfem_app.create_object(
+        rfem.structure_core.Node(coordinate_1=2)
+    )
+```
+
+## Documentation & Support
+- 📖 **API Documentation**: [API Docs](https://www.dlubal.com/en/solutions/dlubal-api/api-documentation/index)
+- 💬 **Support**: Contact [Dlubal Support](https://www.dlubal.com/en/support-and-learning)
+- 🔑 **Extranet**: [API & Cloud Dashboard](https://www.dlubal.com/en/extranet/my-account)
+
+---
+
+## License
+This package is proprietary software and requires an **active API Service subscription**. Unauthorized use is prohibited.
+