Merge pull request xsuite#259 from szymonlopaciuk/prebuild_kernels_co…

…mmand

add a command line script `xsuite-prebuild` to precompile trackers

docs/installation.rst

@@ -20,6 +20,14 @@ The Xsuite packages can be installed using pip:
 
 This installation allows using Xsuite on CPU. To use Xsuite on GPU, with the cupy and/or pyopencl you need to install the corresponding packages, as described in the :ref:`dedicated section<gpuinst>`.
 
+After the installation, you can choose to precompile some often-used kernels, in
+order to reduce the waiting time spent on running the simulations later on. This
+can be accomplished simply by running the following command:
+
+.. code-block:: bash
+
+    xsuite-precompile
+
 
 Developer installation
 ======================

setup.py

@@ -1,4 +1,4 @@
-from setuptools import setup, find_packages, Extension
+from setuptools import setup, find_packages
 from pathlib import Path
 
 #######################################
@@ -33,13 +33,16 @@
         'xfields',
         'xpart',
         'xdeps'
-        ],
+    ],
     url='https://xsuite.readthedocs.io/',
     license='Apache 2.0',
     download_url="https://pypi.python.org/pypi/xsuite",
     project_urls={
-            "Bug Tracker": "https://github.com/xsuite/xsuite/issues",
-            "Documentation": 'https://xsuite.readthedocs.io/',
-            "Source Code": "https://github.com/xsuite/xsuite",
-        },
-    )
+        "Bug Tracker": "https://github.com/xsuite/xsuite/issues",
+        "Documentation": 'https://xsuite.readthedocs.io/',
+        "Source Code": "https://github.com/xsuite/xsuite",
+    },
+    entry_points={
+        'console_scripts': ['xsuite-prebuild=xsuite.cli:main'],
+    },
+)

xsuite/cli.py

@@ -0,0 +1,10 @@
+# copyright ################################# #
+# This file is part of the Xobjects Package.  #
+# Copyright (c) CERN, 2022.                   #
+# ########################################### #
+from xtrack.prebuild_kernels import regenerate_kernels
+
+
+def main():
+    regenerate_kernels()
+    print('Successfully compiled kernels.')