Skip to content

Commit

Permalink
update installation with git repo
Browse files Browse the repository at this point in the history
  • Loading branch information
superstar54 committed Dec 8, 2023
1 parent bf8496a commit 71c4454
Showing 2 changed files with 6 additions and 7 deletions.
11 changes: 5 additions & 6 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -19,22 +19,21 @@ Please refer to the `documentation <https://aiida.readthedocs.io/projects/aiida-

Installation
============


The recommended method of installation is to use the Python package manager |pip|_:

.. code-block:: console
$ pip install aiida-worktree
$ pip install git+https://github.com/superstar54/aiida-worktree
This will install the latest stable version that was released to PyPI.
This will install the latest version from the main branch of the repository.

To install the package from source, first clone the repository and then install using |pip|_:
To install the package in editable mode, first clone the repository and then install using |pip|_:

.. code-block:: console
$ git clone https://github.com/superstar54/aiida-worktree
$ pip install -e aiida-worktree
$ cd aiida-worktree
$ pip install -e .
The ``-e`` flag will install the package in editable mode, meaning that changes to the source code will be automatically picked up.

2 changes: 1 addition & 1 deletion docs/source/quick_start.ipynb
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@
"In this tutorial, you will get a quick view of `AiiDA-WorkTree`. To run this tutorial, you need to install `aiida-worktree`. Open a terminal and run:\n",
"\n",
"```console\n",
"pip install aiida-worktree\n",
"pip install git+https://github.com/superstar54/aiida-worktree\n",
"```\n",
"\n",
"Start the AiiDA daemon if needed:\n",

0 comments on commit 71c4454

Please sign in to comment.