Skip to content

Commit

Permalink
[Docs] Added install from source paragraph (#106)
Browse files Browse the repository at this point in the history
  • Loading branch information
madagra authored Oct 16, 2023
1 parent 1c32e60 commit d63fba1
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 4 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ pip install qadence
To install other backends or the visualization tool, please use:

```bash
pip install "qadence[braket, pulser, visualization]"
pip install "qadence[braket,pulser,visualization]"
```

!!! warning
Expand All @@ -67,11 +67,34 @@ pip install "qadence[braket, pulser, visualization]"
conda install python-graphviz
```

## Install from source

We recommend to use the [`hatch`](https://hatch.pypa.io/latest/) environment manager to install `qadence` from source:

```bash
python -m pip install hatch

# get into a shell with all the dependencies
python -m hatch shell

# run a command within the virtual environment with all the dependencies
python -m hatch run python my_script.py
```

!!! warning
`hatch` will not combine nicely with other environment managers such Conda. If you want to use Conda,
install it from source using `pip`:

```bash
# within the Conda environment
python -m pip install -e .
```

## Citation

If you use Qadence for a publication, we kindly ask you to cite our work using the following BibTex entry:

```
```latex
@misc{qadence2023pasqal,
url = {https://github.com/pasqal-io/qadence},
title = {Qadence: {A} {D}igital-analog quantum programming interface.},
Expand Down
27 changes: 25 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ pip install qadence
To install other backends or the visualization tool, please use:

```bash
pip install "qadence[braket, pulser, visualization]"
pip install "qadence[braket,pulser,visualization]"
```

!!! warning
Expand All @@ -156,11 +156,34 @@ pip install "qadence[braket, pulser, visualization]"
conda install python-graphviz
```

## Install from source

We recommend to use the [`hatch`](https://hatch.pypa.io/latest/) environment manager to install `qadence` from source:

```bash
python -m pip install hatch

# get into a shell with all the dependencies
python -m hatch shell

# run a command within the virtual environment with all the dependencies
python -m hatch run python my_script.py
```

!!! warning
`hatch` will not combine nicely with other environment managers such Conda. If you want to use Conda,
install it from source using `pip`:

```bash
# within the Conda environment
python -m pip install -e .
```

## Citation

If you use Qadence for a publication, we kindly ask you to cite our work using the following BibTex entry:

```
```latex
@misc{qadence2023pasqal,
url = {https://github.com/pasqal-io/qadence},
title = {Qadence: {A} {D}igital-analog quantum programming interface.},
Expand Down

0 comments on commit d63fba1

Please sign in to comment.