Skip to content

Commit

Permalink
update readthedocs yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
fabian-sp committed Nov 29, 2024
1 parent 14152d3 commit e9a78c0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ formats:
python:
install:
- requirements: readthedocs-requirements.txt
- method: setuptools
- method: pip
path: .

16 changes: 9 additions & 7 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,31 @@ Getting started
Installation
^^^^^^^^^^^^^^^^

``GGLasso`` is available over Pypi or `Github`_. For installation with pip, simply run
The official repository can be found on `Github`_
``GGLasso`` is available over ``pip`` and ``conda``. For installation from PyPi, simply run

.. code-block::
pip install gglasso
To install from source, clone the repository and make sure you have all requirements installed. Then move to the directory and run
For ``conda``, use

.. code-block::
python setup.py
conda install -c conda-forge gglasso
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
Alternatively, you can clone from Github and install a developer version with the command

.. code-block::
python setup.py clean --all develop clean --all
python -m pip install --editable .
To make sure that everything works properly you can run unit tests in ``gglasso/tests``, for example
To make sure that everything works properly you can run unit tests with

.. code-block::
pytest gglasso/ -v
pytest tests/ -v
To import from ``GGLasso`` in Python, type for example

Expand Down

0 comments on commit e9a78c0

Please sign in to comment.