Feature: Add new Python API to convert between scopes configuration files#2924
Open
santorofer wants to merge 2 commits intoMDSplus:alphafrom
Open
Feature: Add new Python API to convert between scopes configuration files#2924santorofer wants to merge 2 commits intoMDSplus:alphafrom
santorofer wants to merge 2 commits intoMDSplus:alphafrom
Conversation
A new Python API to be able to convert between jScope configuration files and dwscope configuration files.
>>> import MDSplus
>>> MDSplus.Scope
MDSplus.Scope( MDSplus.ScopePlot( MDSplus.ScopeSignalColor( MDSplus.ScopeSignalMode1D(
MDSplus.ScopeGeometry( MDSplus.ScopeSignal( MDSplus.ScopeSignalMarker( MDSplus.ScopeSignalMode2D(
Usage:
Convert between dwscope config file to jScope config file:
>>> MDSplus.Scope.load('plasma.dat', 'plasma.jscp')
santorofer
changed the title
The new Python API code make use of: 1- from typing import Optional: only for Python >= v3.10 2- @DataClass: only for Python version >= 3.7 Therefore, this API needs Python 3.10 or greater.
santorofer
added
api/python
heidthecamp
reviewed
Mar 4, 2026
Comment on lines
-1
to
-25
| # | ||
| # Copyright (c) 2017, 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. | ||
| # | ||
|
|
Contributor
There was a problem hiding this comment.
Is there a reason we're removing the license here?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A new Python API to be able to convert between jScope configuration files and dwscope configuration files.
This new API replaces the old scope API with new functionality.
Usage:
For example, convert between dwscope config file to jScope config file: