Skip to content
This repository has been archived by the owner on Sep 24, 2024. It is now read-only.

Commit

Permalink
make setup env private
Browse files Browse the repository at this point in the history
  • Loading branch information
hatemhelal committed May 3, 2024
1 parent d3faac6 commit 9f20428
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions mess/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Copyright (c) 2024 Graphcore Ltd. All rights reserved.
"""MESS: Modern Electronic Structure Simulations
The mess simulation environment can be customised by setting the following environment
variables:
* ``MESS_ENABLE_FP64``: enables float64 precision. Defaults to ``True``.
* ``MESS_CACHE_DIR``: JIT compilation cache location. Defaults to ``~/.cache/mess``
"""

import importlib.metadata

__version__ = importlib.metadata.version("mess")
Expand All @@ -10,14 +18,7 @@
__all__ = ["molecule", "Hamiltonian", "minimise", "basisset"]


def setup_env():
"""Setup the environment for MESS
This can be customised by setting the environment variables:
MESS_ENABLE_FP64: enables float64 precision. Defaults to True.
MESS_CACHE_DIR: JIT compilation cache location. Defaults to ~/.cache/mess
"""
def _setup_env():
import os
import os.path as osp

Expand All @@ -31,4 +32,4 @@ def setup_env():
cc.set_cache_dir(cache_dir)


setup_env()
_setup_env()

0 comments on commit 9f20428

Please sign in to comment.