Support config files

.github/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+## Dependencies
+
+### More on tools
+
+The `runcardsrunner` package is managed by `poetry`. This has been chosen to
+automate a series of tasks, and to grant reproducible installations maintaining
+a `poetry.lock` file.
+
+It might happen (frequently) that `poetry` complains about version
+dependencies, if inconsistent. This is not `poetry`'s fault, and it's a useful
+warning that will prevent to just break when installed by an user with a
+different environment.

.gitignore

@@ -1,6 +1,5 @@
 .prefix/
-# ignore any folder like '<DATASET>-YYYYMMDDHHmmss'
-*-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]/
+results/
 # madgraph junk
 py.py
 additional_command

README.md

@@ -12,14 +12,17 @@ There is no released version currently.
 
 ### Dev
 
-For development the dependencies can be bootstrapped by running:
+For development you need the following tools:
 
-```sh
-./rr install
-```
+- `poetry`, follow [installation
+  instructions](https://python-poetry.org/docs/#installation)
+- `poetry-dynamic-versioning`, used to manage the version (see
+  [repo](https://github.com/mtkennerly/poetry-dynamic-versioning))
+- `pre-commit`, to run maintenance hooks before commits (see
+  [instructions](https://pre-commit.com/#install))
 
-See [below](#non-python-dependencies) for a few dependencies (already available
-on most systems).
+See [below](.github/CONTRIBUTING.md#non-python-dependencies) for a few more
+dependencies (already available on most systems).
 
 ## Documentation
 
@@ -32,26 +35,3 @@ cd docs
 make html
 make view
 ```
-
-### Non Python dependencies
-
-Even if the bootstrap script and the installation management try to reduce as
-much as possible the amount of dependencies, still a few ingredients have to be
-available on the system.
-
-To run `./rr install`:
-
-- `python` itself
-- `pip` available as a module of the `python` that is running `rr` (as usually
-  is)
-- `curl`
-
-To install `pineappl`:
-
-- `pkg-config`
-- `openssl.pc` (e.g. on Debian available in the `libssl-dev` package)
-
-To install `mg5amc@nlo` and its dependencies:
-
-- `gfortran`
-- `wget`

docs/source/conf.py

@@ -115,7 +115,7 @@
 # Thanks https://github.com/bskinn/sphobjinv
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
-    "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy", None),
     "numpy": ("https://numpy.org/doc/stable", None),
     "pygit2": ("https://www.pygit2.org/", None),
     "pandas": ("https://pandas.pydata.org/docs/", None),

docs/source/index.rst

@@ -28,6 +28,30 @@ There are two ways of installing ``rr``, that are:
   and in this case, ``rr`` to be used is always the one provided as executable.
   in the repository.
 
+Non Python dependencies
+-----------------------
+
+Even if the bootstrap script and the installation management try to reduce as
+much as possible the amount of dependencies, still a few ingredients have to be
+available on the system.
+
+To run the CLI:
+
+- ``python`` itself
+- ``pip`` available as a module of the ``python`` that is running ``rr`` (as usually
+  is)
+- ``curl``
+
+To install ``pineappl``:
+
+- ``pkg-config``
+- ``openssl.pc`` (e.g. on Debian available in the ``libssl-dev`` package)
+
+To install ``mg5amc@nlo`` and its dependencies:
+
+- ``gfortran``
+- ``wget``
+
 
 .. toctree::
    :maxdepth: 1