Add open sourcing bits. (#1)

AUTHORS.txt

@@ -1,4 +1,5 @@
 Matthias Wolf
 Fernando Pereira
 Sergio Rivas Gomez
+Luc Dominic Grosheintz-Laval
 Tristan Carel

Dockerfile

@@ -0,0 +1,5 @@
+FROM python:latest
+
+RUN apt-get update \
+ && apt-get install -y libopenmpi-dev
+RUN pip install /workspace

README.rst

@@ -1,3 +1,6 @@
+.. image:: doc/source/_static/banner.jpg
+   :alt: A nice banner for functionalizer
+
 Functionalizer
 ==============
 
@@ -10,9 +13,27 @@ To process the large quantities of data optimally, this software uses PySpark.
 Installation
 ------------
 
-For manual installation via `pip`, a compiler handling C++17 will be necessary.
-Otherwise, all `git` submodules should be checked out and `cmake` as well as `ninja` be
-installed.
+The easiest way to install `functionalizer` is via:
+
+.. code-block:: console
+
+   pip install functionalizer
+
+Due to a dependency on ``mpi4py``, a MPI implementation needs to be installed on the
+system used.  On Ubuntu, this can be achieved with:
+
+.. code-block:: console
+
+   apt-get install -y libopenmpi-dev
+
+For manual installation from sources via ``pip``, a compiler handling C++17 will be
+necessary.  Furthermore, all ``git`` submodules should be checked out:
+
+.. code-block:: console
+
+   gh repo clone BlueBrain/functionalizer -- --recursive --shallow-submodules
+   cd functionalizer
+   pip install .
 
 Spark and Hadoop should be installed and set up as runtime dependencies.
 
@@ -27,4 +48,12 @@ Where the final argument `edges.h5` may also be a directory of Parquet files.  W
 running on a cluster with multiple nodes, care should be taken that every rank occupies a
 whole node, Spark will then spread out across each node.
 
+Acknowledgment
+--------------
+The development of this software was supported by funding to the Blue Brain Project,
+a research center of the École polytechnique fédérale de Lausanne (EPFL),
+from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.
+
+Copyright (c) 2017-2024 Blue Brain Project/EPFL
+
 .. _SONATA extension: https://sonata-extension.readthedocs.io

doc/source/conf.py

@@ -56,3 +56,4 @@
 html_theme_options = {"metadata_distribution": "functionalizer"}
 html_title = "functionalizer"
 html_show_sourcelink = False
+html_static_path = ['_static']

pyproject.toml

@@ -1,12 +1,12 @@
 [build-system]
-requires = ["scikit-build-core[pyproject]", "setuptools_scm"]
+requires = ["scikit-build-core[pyproject]", "setuptools_scm", "cmake", "ninja"]
 build-backend = "scikit_build_core.build"
 
 [project]
 name = "functionalizer"
 dynamic = ["version"]
 description = "A PySpark implementation of the Blue Brain Project Functionalizer"
-license = {"text" = "Blue Brain Project License"}
+license = {"file" = "LICENSE.txt"}
 authors = [{"name" = "BlueBrain HPC", "email" = "bbp-ou-hpc@epfl.ch"}]
 maintainers = [
     {"name" = "Matthias Wolf", "email" = "matthias.wolf@epfl.ch"},
@@ -74,3 +74,12 @@ max-args = 8
 [tool.black]
 extend-exclude = 'deps\/.*$'
 line_length = 100
+
+[tool.cibuildwheel]
+skip = ["cp3{6,7,8}-*", "pp*", "*-win32", "*-manylinux_i686", "*-musllinux_i686", "*-musllinux_x86_64", "*-musllinux_aarch64"]
+# MPI needed for testing with mpi4py
+before-all = "yum install -y openmpi3-devel java-11-openjdk"
+environment = { MPICC="/usr/lib64/openmpi3/bin/mpicc" }
+# Remove setuptools with Spark v4 - v3 has implicit dependency on distutils
+test-requires = ["pytest", "mock", "setuptools"]
+test-command = "pytest --run-slow {project}/tests"