osis-python 0.5.5__tar.gz → 0.6.1__tar.gz

{osis_python-0.5.5/src/osis_python.egg-info → osis_python-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osis-python
-Version: 0.5.5
+Version: 0.6.1
 Summary: A Python client library for Osis APDL
 Author-email: "CCCC Highway Consultant Co. Ltd." <support@osisbim.com>
 License-Expression: MIT
@@ -55,6 +55,7 @@ pip install osis-python -i https://pypi.org/simple
 
 - OSIS >= 5.0 (includes the required Python runtime environment)
 - Python >= 3.8
+- **Solver-only mode** additionally requires the solver distribution that ships `PySolver.dll` (e.g. `D:\OSIS_Solver\Rbin64`).
 
 ## Quick Start
 
@@ -76,22 +77,22 @@ engine.control.set_calc_tendon(True)
 engine.control.set_calc_creep(True)
 
 # Create sections
-sec = engine.section.create_circle("CircleSection", d=0.5, tw=0.02)
+sec = engine.section.create_circle(no=1, name="CircleSection", d=0.5)
 
 # Create materials
-mat = engine.material.create_conc("C30Concrete", eCode="JTG3362_2018", eGrade="C30")
+mat = engine.material.create_conc(no=1, name="C30Concrete", code="JTG3362_2018", grade="C30")
 
 # Create nodes
-n1 = engine.node.create(0, 0, 0)
-n2 = engine.node.create(15, 0, 0)
+n1 = engine.node.create(no=1, x=0, y=0, z=0)
+n2 = engine.node.create(no=2, x=15, y=0, z=0)
 
 # Create elements
 elem = engine.element.create_beam3d(
-    n1.no, n2.no, nMat=mat.no, nSec1=sec.no, nSec2=sec.no
+    no=1, node1=n1.no, node2=n2.no, nMat=mat.no, nSec1=sec.no, nSec2=sec.no
 )
 
 # Create boundaries
-bd = engine.boundary.create_general(bX=1, bY=1, bZ=1, bRX=1, bRY=1, bRZ=1)
+bd = engine.boundary.create_general(no=1, x=1, y=1, z=1, rx=1, ry=1, rz=1, rw=1)
 bd.assign("a", [n1.no])
 
 # Create load case and add loads
@@ -134,10 +135,35 @@ If you don't need the convenience methods of Engine, you can also import individ
 from pyosis.material import material_manager
 from pyosis.node import node_manager
 
-mat = material_manager.create_conc("C30", eCode="JTG3362_2018", eGrade="C30")
+mat = material_manager.create_conc(no=1, name="C30", code="JTG3362_2018", grade="C30")
 node = node_manager.create(0, 0, 0)
 ```
 
+### 4. Using OSISSolver — Start the Solver Directly (Solver-Only Mode)
+
+By default, `OSISEngine()` connects to an already-running OSIS GUI process. If you want to drive the solver **without opening the GUI** (e.g. for headless batch runs, CI, or server-side automation), use `OSISSolver` to load the solver DLL directly via ctypes and launch its HTTP server:
+
+```python
+from pyosis.core.solver import OSISSolver
+from pyosis.core.engine import OSISEngine
+
+# Load <install>/PySolver.dll and start the HTTP server (default port 18080)
+solver = OSISSolver(osis_install_path=r"D:\OSIS_Solver\Rbin64")
+engine = OSISEngine.from_solver(solver)
+
+# Create a project (type 101 = bridge analysis), then build the model as usual
+engine.project.create(101, r"D:\work\my_bridge\my_bridge.sis")
+engine.control.set_gravity_acceleration(9.8066)
+# ... build sections / materials / nodes / elements ...
+engine.solve()
+```
+
+Notes on solver-only mode:
+
+- `osis_install_path` must be the directory containing `PySolver.dll` (and its dependency DLLs).
+- The solver needs a project to exist before model commands run: call `engine.project.create()` / `open()` first.
+- Crash minidumps are written to `<install>\Error\dmp\` (created on startup).
+
 ## Core Architecture
 
 ### Manager System
@@ -165,66 +191,84 @@ pyosis adopts a Manager pattern to organize code. Each module corresponds to a M
 | ResultManager | `engine.result` | Result export (load case / envelope / check results) |
 | ControlManager | `engine.control` | Global control parameters |
 | ProjectManager | `engine.project` | Project operations |
+| DisplayManager | `engine.display` | Display control (show/hide boundaries, loads, tendons; view orientation; display switches) |
 
 ### Sub-Managers
 
 Some managers contain sub-managers, accessed via attributes:
 
 ```python
-# Element groups
-grp = engine.element.group.create("MainGirderElements")
-grp.add([1, 2, 3])
+# Element groups (create + add elements in one call)
+engine.element.group.create("MainGirderElements", "c")            # create empty group
+engine.element.group.create("MainGirderElements", "a", "1to3")    # add elements 1-3
 
 # Boundary groups
-bg = engine.boundary.group.create("AbutmentBoundaries")
-bg.add([1, 2])
+engine.boundary.group.create("AbutmentBoundaries", "c")
+engine.boundary.group.create("AbutmentBoundaries", "a", "1to2")
 
 # Various boundary types
-engine.boundary.create_general(bX=1, bY=1, bZ=1, bRX=1, bRY=1, bRZ=1)  # General support
-engine.boundary.create_master_slave(nMast=1, nSlav=2, dDir=1)           # Master-slave
-engine.boundary.create_release(nElem=1, iReleaseEnd=2)                  # End release
-engine.boundary.create_elstcspt(nNode=1, dK=[1e9, 1e9, 1e9, 0, 0, 0])  # Elastic support
-engine.boundary.create_general_elstcspt(nNode=1, bX=1, bY=1, bZ=1, dKx=1e9, dKy=1e9, dKz=1e9)  # General elastic
-engine.boundary.create_rigid(nNode1=1, nNode2=2)                        # Rigid link
-engine.boundary.create_section_factor(nElem=1, iEnd=1)                  # Section factor
+engine.boundary.create_general(no=1, x=1, y=1, z=1, rx=1, ry=1, rz=1, rw=1)           # General support
+engine.boundary.create_master_slave(no=1, node=1, dx=1, dy=1, dz=1, rx=0, ry=1, rz=1, coincident=2)  # Master-slave
+engine.boundary.create_rigid(no=1, nNodeI=1)                                               # Rigid link
+engine.boundary.create_elstcspt(no=1, coor="", x=0, dx=1e9, y=0, dy=1e9, z=0, dz=1e9)     # Elastic support
 
 # Tendons
 prop = engine.tendon.prop.create_in(
-    "15-10", mat_no=1, e_code="GBT5224_2014",
-    diameter=15.2, n_num=10, d_pipe=0.09
+    name="15-10", mat=3, code="GBT5224_2014",
+    diameter=15.2, num=10, pipe=0.09,
 )
 shape = engine.tendon.shape.create_arc3d(
-    "N1", n_num=2, prop="15-10",
+    name="N1", n_num=2, prop="15-10",
     element_group="MainGirderElements", curve_name="curve1"
 )
 
 # Live loads
-grade = engine.live.grade.create("HighwayClassI")
-lane = engine.live.lane.create("Lane1")
-case = engine.live.case.create("LiveLoadCase 1")
+grade = engine.live.grade.create(name="HighwayClassI", code="JTGD60_2015", type="HIGHWAY_I")
+lane = engine.live.lane.create(name="Lane1", type="VE")
+case = engine.live.case.create(name="LiveLoadCase 1", code="JTGD60_2015")
+```
+
+### Display Control
+
+```python
+# Show/hide boundaries, loads and tendons
+engine.display.disp_ctrl("bc", "all", "all", 1)          # Show all boundaries
+engine.display.disp_ctrl("lg", "nforce", "all", 0)       # Hide all concentrated forces
+engine.display.disp_ctrl("td", "all", ["T1", "T2"], 1)   # Show specific tendons
+
+# View orientation
+engine.display.set_view("top")          # standard / top / right / front
+
+# Display switch
+engine.display.set_plsm(1)              # 0 = off, 1 = on
 ```
 
 ### Property & Thickness Management
 
 ```python
-# Coordinate systems
-engine.prop.coord.create_local("CS1", origin=[0, 0, 0], x_axis=[1, 0, 0], y_axis=[0, 1, 0])
+# Coordinate systems (三点定义)
+engine.prop.coord.create_three_point(
+    no=1, p1x=0, p1y=0, p1z=0,
+    p2x=1, p2y=0, p2z=0,
+    p3x=0, p3y=1, p3z=0,
+)
 
-# Creep and shrinkage
-engine.prop.creep_shrink.create("Creep1", eCode="JTG3362_2018", eGrade="C30")
+# Creep and shrinkage(no, name, avg_humidity, birth_time, type_coeff, shrink_birth)
+engine.prop.creep_shrink.create(no=1, name="Creep1", avg_humidity=70.0,
+                                birth_time=7, type_coeff=5.0, shrink_birth=3)
 
-# Damping
-engine.prop.damping.create("Damping1", dDmp=0.05)
+# Damping (Rayleigh 自定义系数)
+engine.prop.damping.create_rayleigh_custom(name="Damping1", alpha=0.05, beta=0.005)
 
-# P-U curve (for soil-structure interaction)
-engine.prop.pu_curve.create("PU1", data=[(0, 0), (0.01, 1000), (0.02, 1500)])
+# P-U curve (no, name, curve_type, num, values)
+#   curve_type: 1=水平位移推力 2=竖向位移推力 3=竖向力位移
+engine.prop.pu_curve.create(no=1, name="PU1", curve_type=1, num=3, values=[0, 0.01, 1000, 0.02, 1500])
 
-# Element thickness assignment
-engine.prop.thickness.assign_element(nElem=1, dThick=0.3)
+# Element thickness assignment (thickness, op, *elems)
+engine.prop.assign_component_thickness(thickness=0.3, op="a", elems=[1])
 
-# Shell thickness properties
-engine.thickness.create_uniform("Thick1", dThick=0.3)
-engine.thickness.create_tapered("Thick2", dThick1=0.2, dThick2=0.4)
+# Shell thickness (no, in_plane, out_plane)
+engine.thickness.create(no=1, in_plane=0.3, out_plane=0.3)
 ```
 
 ### Geometry Queries
@@ -264,10 +308,10 @@ Some `create_*` functions support explicit numbering via the `no` parameter. If
 
 ```python
 # Auto-assigned number
-sec = engine.section.create_circle("Section1", d=0.5)
+sec = engine.section.create_circle(name="Section1", d=0.5)
 
 # Explicit number
-sec = engine.section.create_circle("Section1", d=0.5, no=100)
+sec = engine.section.create_circle(name="Section1", d=0.5, no=100)
 ```
 
 ## Result Export
@@ -324,7 +368,7 @@ engine.section.create_circle("CircleSection2", d=0.180, tw=0.008, no=2)
 
 # Materials
 engine.material.create_steel(
-    "Steel1", eCode="JTGD64_2015", eGrade="Q345", dDmp=0.05, no=1
+    "Steel1", code="JTGD64_2015", grade="Q345", dmp=0.05, no=1
 )
 
 # Nodes
@@ -354,6 +398,13 @@ lc.create_nforce(4, dFx=200000, dFy=0, dFz=0)
 engine.solve()
 ```
 
-## More Resources
+## End-to-End Demo
+
+See [`tests/pyosis_demo.py`](tests/pyosis_demo.py) for a runnable end-to-end example that:
+
+- Starts the solver directly via `OSISSolver` (no GUI required)
+- Builds the 25m 简支小箱梁 example model (10 prep modules)
+- Runs `engine.solve()`
+- Exports LCND / LCEF / EnvND / EnvEF results to CSV
 
-- [tests/](tests/): Example code for each module
+The demo reuses the prep modules from `tests/output/output_py/25m简支小箱梁中梁-solveronly/`, so it serves both as a smoke test and a copy-paste template.

{osis_python-0.5.5 → osis_python-0.6.1}/README.md

@@ -24,6 +24,7 @@ pip install osis-python -i https://pypi.org/simple
 
 - OSIS >= 5.0 (includes the required Python runtime environment)
 - Python >= 3.8
+- **Solver-only mode** additionally requires the solver distribution that ships `PySolver.dll` (e.g. `D:\OSIS_Solver\Rbin64`).
 
 ## Quick Start
 
@@ -45,22 +46,22 @@ engine.control.set_calc_tendon(True)
 engine.control.set_calc_creep(True)
 
 # Create sections
-sec = engine.section.create_circle("CircleSection", d=0.5, tw=0.02)
+sec = engine.section.create_circle(no=1, name="CircleSection", d=0.5)
 
 # Create materials
-mat = engine.material.create_conc("C30Concrete", eCode="JTG3362_2018", eGrade="C30")
+mat = engine.material.create_conc(no=1, name="C30Concrete", code="JTG3362_2018", grade="C30")
 
 # Create nodes
-n1 = engine.node.create(0, 0, 0)
-n2 = engine.node.create(15, 0, 0)
+n1 = engine.node.create(no=1, x=0, y=0, z=0)
+n2 = engine.node.create(no=2, x=15, y=0, z=0)
 
 # Create elements
 elem = engine.element.create_beam3d(
-    n1.no, n2.no, nMat=mat.no, nSec1=sec.no, nSec2=sec.no
+    no=1, node1=n1.no, node2=n2.no, nMat=mat.no, nSec1=sec.no, nSec2=sec.no
 )
 
 # Create boundaries
-bd = engine.boundary.create_general(bX=1, bY=1, bZ=1, bRX=1, bRY=1, bRZ=1)
+bd = engine.boundary.create_general(no=1, x=1, y=1, z=1, rx=1, ry=1, rz=1, rw=1)
 bd.assign("a", [n1.no])
 
 # Create load case and add loads
@@ -103,10 +104,35 @@ If you don't need the convenience methods of Engine, you can also import individ
 from pyosis.material import material_manager
 from pyosis.node import node_manager
 
-mat = material_manager.create_conc("C30", eCode="JTG3362_2018", eGrade="C30")
+mat = material_manager.create_conc(no=1, name="C30", code="JTG3362_2018", grade="C30")
 node = node_manager.create(0, 0, 0)
 ```
 
+### 4. Using OSISSolver — Start the Solver Directly (Solver-Only Mode)
+
+By default, `OSISEngine()` connects to an already-running OSIS GUI process. If you want to drive the solver **without opening the GUI** (e.g. for headless batch runs, CI, or server-side automation), use `OSISSolver` to load the solver DLL directly via ctypes and launch its HTTP server:
+
+```python
+from pyosis.core.solver import OSISSolver
+from pyosis.core.engine import OSISEngine
+
+# Load <install>/PySolver.dll and start the HTTP server (default port 18080)
+solver = OSISSolver(osis_install_path=r"D:\OSIS_Solver\Rbin64")
+engine = OSISEngine.from_solver(solver)
+
+# Create a project (type 101 = bridge analysis), then build the model as usual
+engine.project.create(101, r"D:\work\my_bridge\my_bridge.sis")
+engine.control.set_gravity_acceleration(9.8066)
+# ... build sections / materials / nodes / elements ...
+engine.solve()
+```
+
+Notes on solver-only mode:
+
+- `osis_install_path` must be the directory containing `PySolver.dll` (and its dependency DLLs).
+- The solver needs a project to exist before model commands run: call `engine.project.create()` / `open()` first.
+- Crash minidumps are written to `<install>\Error\dmp\` (created on startup).
+
 ## Core Architecture
 
 ### Manager System
@@ -134,66 +160,84 @@ pyosis adopts a Manager pattern to organize code. Each module corresponds to a M
 | ResultManager | `engine.result` | Result export (load case / envelope / check results) |
 | ControlManager | `engine.control` | Global control parameters |
 | ProjectManager | `engine.project` | Project operations |
+| DisplayManager | `engine.display` | Display control (show/hide boundaries, loads, tendons; view orientation; display switches) |
 
 ### Sub-Managers
 
 Some managers contain sub-managers, accessed via attributes:
 
 ```python
-# Element groups
-grp = engine.element.group.create("MainGirderElements")
-grp.add([1, 2, 3])
+# Element groups (create + add elements in one call)
+engine.element.group.create("MainGirderElements", "c")            # create empty group
+engine.element.group.create("MainGirderElements", "a", "1to3")    # add elements 1-3
 
 # Boundary groups
-bg = engine.boundary.group.create("AbutmentBoundaries")
-bg.add([1, 2])
+engine.boundary.group.create("AbutmentBoundaries", "c")
+engine.boundary.group.create("AbutmentBoundaries", "a", "1to2")
 
 # Various boundary types
-engine.boundary.create_general(bX=1, bY=1, bZ=1, bRX=1, bRY=1, bRZ=1)  # General support
-engine.boundary.create_master_slave(nMast=1, nSlav=2, dDir=1)           # Master-slave
-engine.boundary.create_release(nElem=1, iReleaseEnd=2)                  # End release
-engine.boundary.create_elstcspt(nNode=1, dK=[1e9, 1e9, 1e9, 0, 0, 0])  # Elastic support
-engine.boundary.create_general_elstcspt(nNode=1, bX=1, bY=1, bZ=1, dKx=1e9, dKy=1e9, dKz=1e9)  # General elastic
-engine.boundary.create_rigid(nNode1=1, nNode2=2)                        # Rigid link
-engine.boundary.create_section_factor(nElem=1, iEnd=1)                  # Section factor
+engine.boundary.create_general(no=1, x=1, y=1, z=1, rx=1, ry=1, rz=1, rw=1)           # General support
+engine.boundary.create_master_slave(no=1, node=1, dx=1, dy=1, dz=1, rx=0, ry=1, rz=1, coincident=2)  # Master-slave
+engine.boundary.create_rigid(no=1, nNodeI=1)                                               # Rigid link
+engine.boundary.create_elstcspt(no=1, coor="", x=0, dx=1e9, y=0, dy=1e9, z=0, dz=1e9)     # Elastic support
 
 # Tendons
 prop = engine.tendon.prop.create_in(
-    "15-10", mat_no=1, e_code="GBT5224_2014",
-    diameter=15.2, n_num=10, d_pipe=0.09
+    name="15-10", mat=3, code="GBT5224_2014",
+    diameter=15.2, num=10, pipe=0.09,
 )
 shape = engine.tendon.shape.create_arc3d(
-    "N1", n_num=2, prop="15-10",
+    name="N1", n_num=2, prop="15-10",
     element_group="MainGirderElements", curve_name="curve1"
 )
 
 # Live loads
-grade = engine.live.grade.create("HighwayClassI")
-lane = engine.live.lane.create("Lane1")
-case = engine.live.case.create("LiveLoadCase 1")
+grade = engine.live.grade.create(name="HighwayClassI", code="JTGD60_2015", type="HIGHWAY_I")
+lane = engine.live.lane.create(name="Lane1", type="VE")
+case = engine.live.case.create(name="LiveLoadCase 1", code="JTGD60_2015")
+```
+
+### Display Control
+
+```python
+# Show/hide boundaries, loads and tendons
+engine.display.disp_ctrl("bc", "all", "all", 1)          # Show all boundaries
+engine.display.disp_ctrl("lg", "nforce", "all", 0)       # Hide all concentrated forces
+engine.display.disp_ctrl("td", "all", ["T1", "T2"], 1)   # Show specific tendons
+
+# View orientation
+engine.display.set_view("top")          # standard / top / right / front
+
+# Display switch
+engine.display.set_plsm(1)              # 0 = off, 1 = on
 ```
 
 ### Property & Thickness Management
 
 ```python
-# Coordinate systems
-engine.prop.coord.create_local("CS1", origin=[0, 0, 0], x_axis=[1, 0, 0], y_axis=[0, 1, 0])
+# Coordinate systems (三点定义)
+engine.prop.coord.create_three_point(
+    no=1, p1x=0, p1y=0, p1z=0,
+    p2x=1, p2y=0, p2z=0,
+    p3x=0, p3y=1, p3z=0,
+)
 
-# Creep and shrinkage
-engine.prop.creep_shrink.create("Creep1", eCode="JTG3362_2018", eGrade="C30")
+# Creep and shrinkage(no, name, avg_humidity, birth_time, type_coeff, shrink_birth)
+engine.prop.creep_shrink.create(no=1, name="Creep1", avg_humidity=70.0,
+                                birth_time=7, type_coeff=5.0, shrink_birth=3)
 
-# Damping
-engine.prop.damping.create("Damping1", dDmp=0.05)
+# Damping (Rayleigh 自定义系数)
+engine.prop.damping.create_rayleigh_custom(name="Damping1", alpha=0.05, beta=0.005)
 
-# P-U curve (for soil-structure interaction)
-engine.prop.pu_curve.create("PU1", data=[(0, 0), (0.01, 1000), (0.02, 1500)])
+# P-U curve (no, name, curve_type, num, values)
+#   curve_type: 1=水平位移推力 2=竖向位移推力 3=竖向力位移
+engine.prop.pu_curve.create(no=1, name="PU1", curve_type=1, num=3, values=[0, 0.01, 1000, 0.02, 1500])
 
-# Element thickness assignment
-engine.prop.thickness.assign_element(nElem=1, dThick=0.3)
+# Element thickness assignment (thickness, op, *elems)
+engine.prop.assign_component_thickness(thickness=0.3, op="a", elems=[1])
 
-# Shell thickness properties
-engine.thickness.create_uniform("Thick1", dThick=0.3)
-engine.thickness.create_tapered("Thick2", dThick1=0.2, dThick2=0.4)
+# Shell thickness (no, in_plane, out_plane)
+engine.thickness.create(no=1, in_plane=0.3, out_plane=0.3)
 ```
 
 ### Geometry Queries
@@ -233,10 +277,10 @@ Some `create_*` functions support explicit numbering via the `no` parameter. If
 
 ```python
 # Auto-assigned number
-sec = engine.section.create_circle("Section1", d=0.5)
+sec = engine.section.create_circle(name="Section1", d=0.5)
 
 # Explicit number
-sec = engine.section.create_circle("Section1", d=0.5, no=100)
+sec = engine.section.create_circle(name="Section1", d=0.5, no=100)
 ```
 
 ## Result Export
@@ -293,7 +337,7 @@ engine.section.create_circle("CircleSection2", d=0.180, tw=0.008, no=2)
 
 # Materials
 engine.material.create_steel(
-    "Steel1", eCode="JTGD64_2015", eGrade="Q345", dDmp=0.05, no=1
+    "Steel1", code="JTGD64_2015", grade="Q345", dmp=0.05, no=1
 )
 
 # Nodes
@@ -323,6 +367,13 @@ lc.create_nforce(4, dFx=200000, dFy=0, dFz=0)
 engine.solve()
 ```
 
-## More Resources
+## End-to-End Demo
+
+See [`tests/pyosis_demo.py`](tests/pyosis_demo.py) for a runnable end-to-end example that:
+
+- Starts the solver directly via `OSISSolver` (no GUI required)
+- Builds the 25m 简支小箱梁 example model (10 prep modules)
+- Runs `engine.solve()`
+- Exports LCND / LCEF / EnvND / EnvEF results to CSV
 
-- [tests/](tests/): Example code for each module
+The demo reuses the prep modules from `tests/output/output_py/25m简支小箱梁中梁-solveronly/`, so it serves both as a smoke test and a copy-paste template.