Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ This module follows the SigMF specification [html](https://sigmf.org/)/[pdf](htt

```bash
pip install sigmf
# or
conda install sigmf
# or
mamba install sigmf
```

### Read SigMF
Expand Down
4 changes: 2 additions & 2 deletions docs/source/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This page is for developers of the ``sigmf-python`` module.
Install
-------

To install the latest git release, build from source:
To install from source:

.. code-block:: console
$ git clone https://github.com/sigmf/sigmf-python.git
$ cd sigmf-python
$ pip install .
$ pip install .[test]
-------
Testing
Expand Down
9 changes: 8 additions & 1 deletion docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,19 @@ Here we discuss how to do all basic operations with SigMF.
Install
-------

To install the latest PyPi release, install from pip:
To install from PyPI using pip:

.. code-block:: console
$ pip install sigmf
To install using conda or mamba (available via `Miniforge <https://conda-forge.org/download/>`_):

.. code-block:: console
$ conda install sigmf # or
$ mamba install sigmf
----------------------
Read a SigMF Recording
----------------------
Expand Down
Loading