You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/getting-started.rst
+9-7
Original file line number
Diff line number
Diff line change
@@ -6,29 +6,31 @@ Getting started
6
6
Installation
7
7
^^^^^^^^^^^^^^^^
8
8
9
-
``GGLasso`` is available over Pypi or `Github`_. For installation with pip, simply run
9
+
The official repository can be found on `Github`_
10
+
``GGLasso`` is available over ``pip`` and ``conda``. For installation from PyPi, simply run
10
11
11
12
.. code-block::
12
13
13
14
pip install gglasso
14
15
15
-
To install from source, clone the repository and make sure you have all requirements installed. Then move to the directory and run
16
+
For ``conda``, use
16
17
17
18
.. code-block::
18
19
19
-
python setup.py
20
+
conda install -c conda-forge gglasso
20
21
21
-
This installs a package called ``gglasso`` in your Python environment. In case you want to edit the source code and use the ``gglasso`` package without re-installing, you can run instead
22
+
Alternatively, you can clone from Github and install a developer version with the command
22
23
23
24
.. code-block::
24
25
25
-
python setup.py clean --all develop clean --all
26
+
python -m pip install --editable .
26
27
27
-
To make sure that everything works properly you can run unit tests in ``gglasso/tests``, for example
28
+
29
+
To make sure that everything works properly you can run unit tests with
28
30
29
31
.. code-block::
30
32
31
-
pytest gglasso/ -v
33
+
pytest tests/ -v
32
34
33
35
To import from ``GGLasso`` in Python, type for example
0 commit comments