Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
bklebel committed Jul 3, 2019
2 parents 4044a01 + 9f30a9d commit b5faeab
Showing 1 changed file with 6 additions and 25 deletions.
31 changes: 6 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -4,32 +4,13 @@

Tools for an abstract sequence editor, parser and runner

The `Sequence_parser` in `Sequence_parsing.py` can read PPMS (resistivity option) sequence files
The `Sequence_runner` in `runSequences.py` contains all logic to run those sequences - however, this is must be inherited: There are many functions which need to be overridden or injected in order to function properly. A demonstration printing-dummy class can be found in `Dummy.py`
The `Sequence_parser` in `Sequence_parsing.py` can read PPMS (measurements: resistivity only) sequence files
The `Sequence_runner` in `runSequences.py` contains all logic to run those sequences - however, this must be inherited: There are many functions which need to be overridden or injected in order to function properly. A demonstration printing-dummy class can be found in `Dummy.py`
The `Sequence_builder` in `Sequence_editor.py` can display the parsed sequences. There exists a start of classes and functions tfor actually editing and building sequences, they are however woefully incomplete, feel free to contribute here!

Most of the generic commands are implemented. It is possible to read arbitrarily nested scanning commands. Empty lines are ignored. In contrast to the logic in the PPMS, when chaining an additional sequence, after the completion of the chained sequence, the mother-sequence continues after the `chain_sequence` command.
Most of the generic commands are implemented. It is possible to read arbitrarily nested scanning commands. Empty lines are ignored. In contrast to the logic in the PPMS, when chaining an additional sequence, after the completion of the chained sequence, the mother-sequence continues after the `chain_sequence` command (multiple nesting allowed too).
Most of the running functionality has not yet been tested -- use at your own risk!

Commands implemented include:
- setting a temperature
- setting a field
- setting a position
- scanning temperature
- scanning field
- scanning position
- scanning time
- Shutdown
- producing sound (Beep)
- waiting
- chain another sequence
- chamber operations
- showing a sequence file remark
Missing functionality in running Sequences is partially documented in issues on [GitHub](https://github.com/bklebel/measureSequences).

Commands only implemented in parsing:
- change the resistivity datafile
- print a res datafile comment
- measure resistivity
- scanning res excitations

Saving a serialised version will write a pickled object and a json file, containing a list with all commands (dictionaries). No reasonable sequences can be written so far, using the PPMS Sequence editor is recommended.
Currently the sequence editor lives outside of the general application (Sequence_editor.py).
Saving a serialised version of the parsed sequence will write a pickled object and a json file, containing a list with all commands (dictionaries). No reasonable sequences can be written so far, using MultiVu is recommended.

0 comments on commit b5faeab

Please sign in to comment.