xopto package

Subpackages

Module contents

BIN_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto/bin'

Directory of binary/executable files.

DATA_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto/data'

Main data storage directory.

MCBASE_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto/mcbase'

Root directory of MC base.

MCCYL_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto/mccyl'

Root directory of MC Cyl.

MCML_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto/mcml'

Root directory of MC ML.

MCVOX_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto/mcvox'

Root directory of MC VOX.

PICKLE_PROTOCOL = 4

Default pickle protocol of the package.

PRIMES_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto/data/primes'

Location of OpenCL random number generator seeds.

ROOT_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto'

The package directory.

SRC_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto/src'

Location of compilable source code.

USER_BIN_PATH = '/home/miran/.xopto/pyxopto/bin'

User directory for built libraries or executables.

USER_BUILD_PATH = '/home/miran/.xopto/pyxopto/build'

User directory for build.

USER_DATA_PATH = '/home/miran/.xopto/pyxopto/data'

User directory for precalculated data.

USER_PATH = '/home/miran/.xopto/pyxopto'

Root path of user data storage.

USER_PRIMES_PATH = '/home/miran/.xopto/pyxopto/data/primes'

User directory for RNG primes.

USER_TMP_PATH = '/home/miran/.xopto/pyxopto/tmp'

User directory for temporary data.

UTIL_PATH = '/home/miran/src/pyxopto/tmp/release/pyxopto/xopto/util'

Root directory of MC utilities.

VERBOSE = False

Verbose reporting.

fulfills_min(requirement: str) → bool[source]

Checks if this version of PyXOpto fulfills the minimum required version.

Parameters

required (str) – Required version as a string, e.g. “0.2.1”.

Returns

fulfills – Returns True if PyXOpto fulfills the requirement, else False.

Return type

bool

Note

PyXOpto version is composed of three numbers (major, minor, patch), e.g. “0.2.0”.

make_user_dirs()[source]

Create all the user directories for data, binary and temporary files.

rebuild(envvars: Optional[dict] = None, verbose: bool = False)[source]

Rebuilds all the external dependencies of xopto (rng).

Parameters

  • envvars (dict) – Additional environmental variables for the build process.

  • verbose (bool) – Enables verbose output.

Examples

Build with default settings and external library installation paths.

>>> import xopto
>>> xopto.rebuild()
        Compiling rng.cpp ...
        Linking rng.o ...
        Moving rng64.so to xopto/bin ...
        Cleanup ...
        All done.
>>>
rebuild_(envvars: Optional[dict] = None)[source]

Rebuilds all the external dependencies of xopto (rng).

Parameters

envvars (dict) – Additional environmental variables for the build process.

Examples

Build with default settings and external library installation paths.

>>> import xopto
>>> xopto.rebuild()
        Compiling rng.cpp ...
        Linking rng.o ...
        Moving rng64.so to xopto/bin ...
        Cleanup ...
        All done.
>>>