Parsing Engines¶
The KeywordParser
and PatternReader
contained in serpentTools/engines.py
are part of the
drewtils v0.1.9 package and
are provided under the following license
The MIT License (MIT)
Copyright (c) Andrew Johnson, 2017
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.
These are designed to facilitate the parsing of files with a regular structure.
For example, the depletion files all contain “chunks” of data that are separated
by empty lines. Each chunk leads off with either the name of the material and
associated variable, or the metadata, e.g. ZAI
, DAYS
. These parsers
help break up these files into more digestible pieces.
Note
For developers, it is not required that these classes be used. These are
bundled with this project to eliminate the need to install extra packages.
Some of the readers, like the
BranchingReader
are not
well suited for this type of parsing.
Class for parsing a file for chunks separated by various keywords. |
|
Class that can read over a file looking for patterns. |
The CSCStreamProcessor
is provided to help with reading
sparse matrices provided by Serpent. These are current found in the
depletion and fission matrix files.
-
class
serpentTools.parsers.base.
CSCStreamProcessor
(stream, regex, dtype=<class 'float'>)¶ Read through a block of text and produce sparse matrices
Note
Rows and columns matched by
regex
will be reduced by one prior to storage. Since we primarily interact with one-indexed MATLAB arrays, we need to convert the indices to something numpy can properly understand- Parameters
stream (IO stream from an opened file) – Object with a
readline
function that returns the next line of text to be readregex (str or compiled regular expression) –
Regular expression that matches the following:
Row of matrix
Column of matrix
Values to be added into resulting matrix.
All values in
match.groups()[2:]
will be converted todatatype
and appended intodata
. The rows and columns are used to populateindices
andindptr
vectorsdatatype (object) – Data type of the numeric values of this matrix.
-
data
¶ Column matrix of all values matched by
regex
after first two positions. Each columns can be used to build a sparse matrix withindices
andindptr
- Type
-
indices
¶ CSC-format indices pointer array
- Type
-
indptr
¶ CSC-format index pointer array. Row indices for column
i
are stored inindices[indptr[i]:indptr[i + 1]]
. Values for columni
are stored indata[indptr[i]:intptr[i + 1]]
.- Type
-
line
¶ Last line read after calling
process()
. Will be the first non-empty line that does not match the passed regular expression- Type
See also