Create amuse_examples package and forwards from amuse.examples

Author: LourensVeen

src/amuse/examples/__init__.py

@@ -0,0 +1,47 @@
+""" Forward examples
+
+This does not use amuse.support.helpers.load_symbol, because we don't have an interface.py
+and because we want to have different error messages. We're not loading a code, in
+short.
+"""
+from importlib import import_module
+from os import environ
+
+
+def _load_symbol(symbol):
+    try:
+        module = import_module("amuse_examples")
+    except ImportError:
+        msg = f"Error: The examples are not installed."
+        if "CONDA_PREFIX" in environ:
+            env = environ["CONDA_DEFAULT_ENV"]
+            msg += (
+                    " To install the examples go to the terminal, make sure that"
+                    f" the '{env}' conda environment is active and that you are in the"
+                    " amuse source directory, then install them using './setup"
+                    " install amuse-examples' and restart your script or reload the"
+                    " kernel.")
+
+        if "VIRTUAL_ENV" in environ:
+            env = environ["VIRTUAL_ENV"]
+            msg += (
+                    " To install the examples, go to the terminal, make sure that"
+                    f" the '{env}' virtual environment is active and that you are in"
+                    " the amuse source directory, then install the code using './setup"
+                    " install amuse-examples' and restart your script or reload the"
+                    " kernel.")
+        raise ImportError(msg) from None
+
+    try:
+        return vars(module)[symbol]
+    except KeyError:
+        raise ImportError(
+                f"cannot import '{symbol}' from 'amuse_examples'"
+                ) from None
+
+
+get = _load_symbol("get")
+to_cell = _load_symbol("to_cell")
+show = _load_symbol("show")
+run = _load_symbol("run")
+shell_is_interactive = _load_symbol("shell_is_interactive")

examples/2017arXiv170307029H_Fig3.py …use_examples/2017arXiv170307029H_Fig3.pyexamples/2017arXiv170307029H_Fig3.py renamed to src/amuse_examples/2017arXiv170307029H_Fig3.py examples/2017arXiv170307029H_Fig3.py renamed to src/amuse_examples/2017arXiv170307029H_Fig3.py

@@ -0,0 +1,22 @@
+# Building and installing packages
+develop-%:
+	support/shared/uninstall.sh $*
+	python -m pip install -e packages/$*
+
+install-%:
+	support/shared/uninstall.sh $*
+	python -m pip install packages/$*
+
+package-%:
+	python3 -m pip install -vv --no-cache-dir --no-deps --no-build-isolation --prefix ${PREFIX} packages/$*
+
+test-%:
+	cd packages/$* && pytest
+
+
+# Cleaning up
+.PHONY: clean
+clean:
+
+.PHONY: distclean
+distclean: clean

src/amuse_examples/Makefile

@@ -15,7 +15,7 @@ def get_ipython():
         return None
 
 
-def get(example_name, prefix="amuse.examples"):
+def get(example_name, prefix="amuse_examples"):
     """
     Retrieves an AMUSE example.
     """
@@ -25,7 +25,7 @@ def get(example_name, prefix="amuse.examples"):
     return inspect.getsource(importlib.import_module(f"{prefix}{example_name}"))
 
 
-def to_cell(example_name, prefix="amuse.examples"):
+def to_cell(example_name, prefix="amuse_examples"):
     """
     Creates a Jupyter cell from an AMUSE example.
     Works also for other modules, set prefix to None in that case.
@@ -36,7 +36,7 @@ def to_cell(example_name, prefix="amuse.examples"):
     shell.set_next_input(contents, replace=False)
 
 
-def show(example_name, prefix="amuse.examples"):
+def show(example_name, prefix="amuse_examples"):
     """
     Prints the source code of an AMUSE example.
     """
@@ -47,7 +47,7 @@ def run(example_name):
     """
     Runs an AMUSE example.
     """
-    prefix = "amuse.examples."
+    prefix = "amuse_examples."
     try:
         example = importlib.import_module(f"{prefix}{example_name}")
     except ImportError as exc: