Enable building and installing Basilisk via pip install.

- `python conanfile.py` still works as before and is recommended for development usage.
- Added broader platform support by building using the limited Python API.
- Added missing runtime dependencies (originally installed as dependencies of 'conan').

Author: dpad

.gitignore

@@ -5,7 +5,7 @@ CMakeCache.txt
 .DS_Store
 dist/
 dist3/
-.pytest_cache 
+.pytest_cache
 docs/html
 docs/build
 docs/source/Documentation/*
@@ -32,7 +32,6 @@ cmake-build*/*
 *.toc
 src/cmake-build-debug/*
 supportData/*/__init__.py
-src/utilities/MonteCarlo/__init__.py
 src/utilities/vizProtobuffer/__init__.py
 src/utilities/vizProtobuffer/vizMessage.pb.cc
 src/utilities/vizProtobuffer/vizMessage.pb.h
@@ -49,3 +48,10 @@ src/moduleTemplates/autoCppModule/*
 **/__pycache__/
 venv/
 .venv/
+
+# VSCode
+.devcontainer
+
+# Python packaging
+*.egg-info
+build/

conanfile.py

@@ -17,6 +17,7 @@
 warningColor = '\033[93m'
 endColor = '\033[0m'
 
+# TODO: Remove this check (deprecated, same as managePipEnvironment flag below).
 try:
     from conans import __version__ as conan_version
     if int(conan_version[0]) >= 2:
@@ -39,15 +40,24 @@
 bskModuleOptionsBool = {
     "opNav": False,
     "vizInterface": True,
-    "buildProject": True
+    "buildProject": True,
+
+    # XXX: Set managePipEnvironment to True to keep the old behaviour of
+    # managing the `pip` environment directly (upgrading, installing Python
+    # packages, etc.). This behaviour is deprecated using the new pip-based
+    # installation, and should only be required for users who are still calling
+    # this file with `python conanfile.py ...`.
+    # TODO: Remove all managePipEnvironment behaviour!
+    "managePipEnvironment": True
 }
 bskModuleOptionsString = {
-    "autoKey": "",
-    "pathToExternalModules": ""
+    "autoKey": "",  # TODO: Remove, used only for managePipEnvironment.
+    "pathToExternalModules": "",
+    "pyLimitedAPI": "",
 }
 bskModuleOptionsFlag = {
     "clean": False,
-    "allOptPkg": False
+    "allOptPkg": False  # TODO: Remove, used only for managePipEnvironment.
 }
 
 # this statement is needed to enable Windows to print ANSI codes in the Terminal
@@ -72,15 +82,6 @@ class BasiliskConan(ConanFile):
     options = {"generator": "ANY"}
     default_options = {"generator": ""}
 
-    # ensure latest pip is installed
-    if is_running_virtual_env() or platform.system() == "Windows":
-        cmakeCmdString = 'python -m pip install --upgrade pip'
-    else:
-        cmakeCmdString = 'python3 -m pip install --upgrade pip'
-    print(statusColor + "Updating pip:" + endColor)
-    print(cmakeCmdString)
-    os.system(cmakeCmdString)
-
     for opt, value in bskModuleOptionsBool.items():
         options.update({opt: [True, False]})
         default_options.update({opt: value})
@@ -119,10 +120,30 @@ class BasiliskConan(ConanFile):
         pass
 
     def system_requirements(self):
+        if not self.options.managePipEnvironment:
+            return  # Don't need to manage any pip requirements
+
+        # TODO: Remove everything here, which only runs if we have set
+        # managePipEnvironment (i.e. conanfile.py-based build).
+
+        # ensure latest pip is installed
+        if is_running_virtual_env() or platform.system() == "Windows":
+            cmakeCmdString = 'python -m pip install --upgrade pip'
+        else:
+            cmakeCmdString = 'python3 -m pip install --upgrade pip'
+        print(statusColor + "Updating pip:" + endColor)
+        print(cmakeCmdString)
+        os.system(cmakeCmdString)
+
         reqFile = open('requirements.txt', 'r')
         required = reqFile.read().replace("`", "").split('\n')
         reqFile.close()
         pkgList = [x.lower() for x in required]
+        pkgList += [
+            # XXX: Add build system requirements which were removed from requirements.txt.
+            "conan>=1.40.1, <2.00.0",
+            "parse>=1.18.0",
+        ]
 
         checkStr = "Required"
         if self.options.allOptPkg:
@@ -268,10 +289,24 @@ def build(self):
         cmake.definitions["BUILD_VIZINTERFACE"] = self.options.vizInterface
         cmake.definitions["EXTERNAL_MODULES_PATH"] = self.options.pathToExternalModules
         cmake.definitions["PYTHON_VERSION"] = f"{sys.version_info.major}.{sys.version_info.minor}"
+
+        if self.options.pyLimitedAPI != "":
+            cmake.definitions["PY_LIMITED_API"] = self.options.pyLimitedAPI
+
+        # Set the build rpath, since we don't install the targets, so that the
+        # shared libraries can find each other using relative paths.
+        cmake.definitions["CMAKE_BUILD_RPATH_USE_ORIGIN"] = True
+
+        # TODO: Set the minimum buildable MacOS version.
+        # (This might be necessary but I'm not sure yet, leaving it here for future reference.)
+        # cmake.definitions["CMAKE_OSX_DEPLOYMENT_TARGET"] = "10.13"
+
         cmake.parallel = True
         print(statusColor + "Configuring cmake..." + endColor)
         cmake.configure()
-        self.add_basilisk_to_sys_path()
+        if self.options.managePipEnvironment:
+            # TODO: Remove this, it's only needed when conanfile.py is handling pip installations.
+            self.add_basilisk_to_sys_path()
         if self.options.buildProject:
             print(statusColor + "\nCompiling Basilisk..." + endColor)
             start = datetime.now()
@@ -294,7 +329,7 @@ def build(self):
 
     def add_basilisk_to_sys_path(self):
         print("Adding Basilisk module to python\n")
-        add_basilisk_module_command = [sys.executable, "-m", "pip", "install", "-e", "."]
+        add_basilisk_module_command = [sys.executable, "-m", "pip", "install", "--no-build-isolation", "-e", "."]
         if not is_running_virtual_env() and self.options.autoKey != 's':
             add_basilisk_module_command.append("--user")
 

pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [
+    "setuptools>=64",       # For PEP 660 (Allow editable installs from pyproject.toml)
+    "setuptools-scm>=8.0",  # Automatically include all Git-controlled files in sdist
+
+    # Requirements for building Basilisk through conanfile
+    "conan>=1.40.1, <2.00.0",
+    "cmake>=3.26",
+    "parse>=1.18.0",
+    "swig==4.2.1"  # Known to work with https://github.com/nightlark/swig-pypi/pull/120
+]
+
+[project]
+name        = 'Basilisk'
+dynamic     = ["version", "dependencies", "optional-dependencies"]
+requires-python = ">=3.8"
+
+readme      = "README.md"
+license     = {file = "LICENSE"}
+description = "Basilisk: an Astrodynamics Simulation Framework"
+
+[project.urls]
+homepage = 'https://hanspeterschaub.info/basilisk/'
+
+[tool.setuptools]
+packages = []  # XXX: Leave blank, populated automatically by setup.py.
+include-package-data = true
+
+[tool.setuptools.package-data]
+"*" = ["*.so", "*.dll", "*.lib", "*.pyd"]  # Include all built objects.
+Basilisk = ["supportData/**/*"]            # Include all support data.
+
+[tool.setuptools.dynamic]
+version = {file = "docs/source/bskVersion.txt"}
+dependencies = {file = "requirements.txt"}
+
+[tool.setuptools.dynamic.optional-dependencies]
+# TODO: Group optional requirements appropriately, e.g. "test", "docs"
+optional = {file = "requirements_optional.txt"}

requirements.txt

@@ -1,9 +1,9 @@
-conan>=1.40.1, <2.00.0
 pandas
-parse>=1.18.0
+matplotlib
+numpy
+colorama
+tqdm
 Pillow
 pytest
 pytest-html
 pytest-xdist
-matplotlib
-numpy