Add source installation instructions

ds4dm · Dec 16, 2020 · 037e118 · 037e118
1 parent ff75c8e
commit 037e118
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git 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
@@ -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 <https://github.com/ds4dm/ecole/tree/master/examples/configuring-bandits.ipynb>

diff --git 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.