nbodykit.utils.GatherArray(data, comm, root=0)[source]¶Gather the input data array from all ranks to the specified root.
This uses Gatherv, which avoids mpi4py pickling, and also avoids the 2 GB mpi4py limit for bytes using a custom datatype
| Parameters: |
|
|---|---|
| Returns: | recvbuffer – the gathered data on root, and None otherwise |
| Return type: | array_like, None |
nbodykit.utils.JSONDecoder(*args, **kwargs)[source]¶Bases: json.decoder.JSONDecoder
A subclass of json.JSONDecoder that can also handle numpy arrays,
complex values, and astropy.units.Quantity objects.
Methods
decode(s[, _w]) |
Return the Python representation of s (a str instance containing a JSON document). |
hook(value) |
|
raw_decode(s[, idx]) |
Decode a JSON document from s (a str beginning with a JSON document) and return a 2-tuple of the Python representation and the index in s where the document ended. |
nbodykit.utils.JSONEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]¶Bases: json.encoder.JSONEncoder
A subclass of json.JSONEncoder that can also handle numpy arrays,
complex values, and astropy.units.Quantity objects.
Methods
default(obj) |
|
encode(o) |
Return a JSON string representation of a Python data structure. |
iterencode(o[, _one_shot]) |
Encode the given object and yield each string representation as available. |
__init__(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]¶Constructor for JSONEncoder, with sensible defaults.
If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.
If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.
If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an OverflowError). Otherwise, no such check takes place.
If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.
If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.
If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.
If specified, separators should be an (item_separator, key_separator)
tuple. The default is (‘, ‘, ‘: ‘) if indent is None and
(‘,’, ‘: ‘) otherwise. To get the most compact JSON representation,
you should specify (‘,’, ‘:’) to eliminate whitespace.
If specified, default is a function that gets called for objects
that can’t otherwise be serialized. It should return a JSON encodable
version of the object or raise a TypeError.
encode(o)[source]¶Return a JSON string representation of a Python data structure.
>>> from json.encoder import JSONEncoder
>>> JSONEncoder().encode({"foo": ["bar", "baz"]})
'{"foo": ["bar", "baz"]}'
item_separator = ', '¶iterencode(o, _one_shot=False)[source]¶Encode the given object and yield each string representation as available.
For example:
for chunk in JSONEncoder().iterencode(bigobject):
mysocket.write(chunk)
key_separator = ': '¶nbodykit.utils.ScatterArray(data, comm, root=0, counts=None)[source]¶Scatter the input data array across all ranks, assuming data is initially only on root (and None on other ranks).
This uses Scatterv, which avoids mpi4py pickling, and also
avoids the 2 GB mpi4py limit for bytes using a custom datatype
| Parameters: | |
|---|---|
| Returns: | recvbuffer – the chunk of data that each rank gets |
| Return type: | array_like |
nbodykit.utils.deprecate(name, alternative, alt_name=None)[source]¶This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emmitted when the function is used.
nbodykit.utils.split_size_3d(s)[source]¶Split s into three integers, a, b, c, such that a * b * c == s and a <= b <= c
| Parameters: | s (int) – integer to split |
|---|---|
| Returns: | a, b, c – integers such that a * b * c == s and a <= b <= c |
| Return type: | int |