mdsthin 0.1__tar.gz

mdsthin-0.1/LICENSE

@@ -0,0 +1,8 @@
+
+Copyright (c) 2024, Massachusetts Institute of Technology 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.

mdsthin-0.1/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.1
+Name: mdsthin
+Version: 0.1
+Summary: MDSplus Thin-Client implemented in pure python
+Author-email: Stephen Lane-Walsh <slwalsh@psfc.mit.edu>
+License: 
+        Copyright (c) 2024, Massachusetts Institute of Technology 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.
+        
+Requires-Python: >=3.7
+License-File: LICENSE
+Requires-Dist: numpy

mdsthin-0.1/README.md

@@ -0,0 +1,116 @@
+
+# mdsthin - Python MDSplus Thin Client Implementation
+
+## Installation
+
+```sh
+git clone https://github.com/MDSplus/mdsthin.git
+python3 -m pip install -e mdsthin
+```
+
+## Tests
+
+```sh
+python3 -m mdsthin.test [-v] [--server SERVER] [--cmod]
+```
+
+## Usage
+
+```py
+import mdsthin
+c = mdsthin.Connection('server')
+
+
+print(c.get('whoami()').data())
+# username
+
+print(c.tcl('show current test'))
+# 123
+
+print(c.get('4 + 5').data())
+# 9
+
+
+c.openTree('test', 123)
+
+
+y = c.get('SIGNAL_NODE').data()
+x = c.get('dim_of(SIGNAL_NODE)').data()
+
+
+gm = c.getMany()
+gm.append('y', 'SIGNAL_NODE')
+gm.append('x', 'dim_of(SIGNAL_NODE)')
+gm.execute()
+
+y = gm.get('y').data()
+x = gm.get('x').data()
+
+
+print(c.getObject('ACTION_NODE').data())
+# Action(...)
+
+
+# Build_Signal(1000. * $VALUE, Word_Unsigned([1,2,3,4,5]), [0QU,10QU,20QU,30QU,40QU])
+Signal(MULTIPLY(Float32(1000.0), dVALUE()), UInt16Array([1, 2, 3, 4, 5]), UInt64Array([0, 10, 20, 30, 40]))
+
+```
+
+## Examples
+
+See the `examples/` folder.
+
+## mdstcl
+
+```
+python3 -m mdsthin.mdstcl SERVER
+Connectiong to: SERVER
+TCL> show current test
+123
+TCL> exit
+```
+
+```py
+import mdsthin
+c = mdsthin.Connection('server')
+
+c.mdstcl()
+TCL> show current test
+123
+TCL> exit
+```
+
+## tdic
+
+```
+python3 -m mdsthin.tdic SERVER
+Connectiong to: SERVER
+TDI> 4 + 5
+9L
+TDI> exit
+```
+
+```py
+import mdsthin
+c = mdsthin.Connection('server')
+
+c.tdic()
+Connectiong to: SERVER
+TDI> 4 + 5
+9L
+TDI> exit
+```
+
+## Compatability with full MDSplus python package
+
+There is a subpackage called `MDSplus` that provides slightly better mappings with the full MDSplus python package.
+
+```py
+from mdsthin import MDSplus
+
+c = MDSplus.Connection('server')
+
+i = Uint32(42)
+
+MDSplus.mdsExceptions.checkStatus(265388200)
+```

mdsthin-0.1/mdsthin/MDSplus/__init__.py

@@ -0,0 +1,68 @@
+#
+# Copyright (c) 2024, Massachusetts Institute of Technology All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or
+# other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+#
+# This package provdes a "best effort" approach to adding compatability with the real MDSplus Python package
+# Several classes are similar but with different names, others are missing entirely. So we map what we can,
+# and can provide additional compatability mapping in the future
+#
+
+from ..connection import Connection, GetMany, PutMany
+
+from ..descriptors import String, StringArray
+from ..descriptors import Int8, Int16, Int32, Int64, Int8Array, Int16Array, Int32Array, Int64Array
+from ..descriptors import List, Dictionary
+from ..descriptors import Signal, Dimension, Window, Slope, Function, Conglom, Range, Action, Dispatch
+from ..descriptors import Program, Routine, Procedure, Method, Dependency, Condition, WithUnits, Call, WithError
+from ..functions import *
+
+# Compatability
+
+from ..descriptors import Descriptor as Data
+from ..descriptors import Descriptor as DescriptorNULL
+from ..descriptors import Descriptor as EmptyData
+
+from ..descriptors import UInt8 as Uint8
+from ..descriptors import UInt16 as Uint16
+from ..descriptors import UInt32 as Uint32
+from ..descriptors import UInt64 as Uint64
+
+from ..descriptors import UInt8Array as Uint8Array
+from ..descriptors import UInt16Array as Uint16Array
+from ..descriptors import UInt32Array as Uint32Array
+from ..descriptors import UInt64Array as Uint64Array
+
+from .. import exceptions as mdsExceptions
+
+mdsExceptions.statusToException = mdsExceptions.getException
+
+def checkStatus(status, ignore=tuple(), message=None):
+    # TODO: message
+    if mdsExceptions.STATUS_NOT_OK(status):
+        exception = mdsExceptions.getException(status)
+        if isinstance(exception, ignore):
+            print(exception)
+        else:
+            raise exception

mdsthin-0.1/mdsthin/__init__.py

@@ -0,0 +1,29 @@
+#
+# Copyright (c) 2024, Massachusetts Institute of Technology All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or
+# other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+from .connection import *
+from .descriptors import *
+from .exceptions import *
+from .functions import *