diff --git a/README.rst b/README.rst index 5d8cea78c..b978cd334 100644 --- a/README.rst +++ b/README.rst @@ -73,8 +73,22 @@ Pip Currently unavailable From Source -^^^^^^^^^^^ -Source builds currently require following the contributing instructions. +----------- +Source builds currently require ``conda`` to fetch the dependencies. + +.. code-block:: bash + + conda env create -n ecole -f dev/conda.yaml + conda activate ecole + cmake -B build/ + cmake --build build/ --parallel + python -m pip install build/python + + +.. warning:: + + This mode of installation is not mature. + In particular, the scip library may not be found when installed outside of the ``ecole`` environemnt. Use It, Cite It diff --git a/docs/index.rst b/docs/index.rst index f35c34239..66675ab4e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -72,7 +72,7 @@ candidate to use for combinatorial optimization, as well as the methodology to d howto/instances.rst .. toctree:: - :caption: Tutorials + :caption: Practical Tutorials :hidden: Configuring the Solver with Bandits diff --git a/docs/installation.rst b/docs/installation.rst index 9b5598242..9e807334b 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -22,4 +22,18 @@ Currently unavailable. From Source ----------- -Source builds currently require following the contributing instructions. +Source builds currently require ``conda`` to fetch the dependencies. + +.. code-block:: bash + + conda env create -n ecole -f dev/conda.yaml + conda activate ecole + cmake -B build/ + cmake --build build/ --parallel + python -m pip install build/python + + +.. warning:: + + This mode of installation is not mature. + In particular, the scip library may not be found when installed outside of the ``ecole`` environemnt.