Skip to content

Commit 753b614

Browse files
committed
DOCS: Updated gnuradio-limesuiteng plugin build from conda recipe section.
1 parent b219398 commit 753b614

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

docs/gettingStarted/plugins/gnuradio/Windows/condaRecipe.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
Build using conda recipe
22
========================
33

4+
Notice
5+
------
6+
7+
This section of documentation describes how to run conda-build tool, update recipes and is reserved for project developers, package maintainers and other contributors. Users are recommended to build Gnuradio-limesuiteng plugin from source (See :ref:`windows-plugin-build-ref`) or install as a conda package from conda package manager (See :ref:`gnuradio-plugin-install-ref`).
8+
49
.. important::
510

611
Compared to standard build procedure, building plugin package using conda-build tool takes more time (5-8 min.) and resources. For development purposes it is advised to build from source using CMake. See :ref:`windows-plugin-build-ref`.
@@ -9,15 +14,19 @@ Build using conda recipe
914

1015
Check out radioconda and conda environment setup. See :ref:`radioconda-setup-ref`.
1116

12-
Gnuradio-limesuiteng plugin for GNURadio can also be built using conda recipe. To build the plugin, LimeSuiteNG conda package must be built and installed localy inside the current conda environment. Plugin recipe files are provided in ``<project>\plugins\gr-limesuiteng\.conda\`` directory. To start the build process, execute the following commands:
17+
18+
Recipe build steps
19+
------------------
20+
21+
Gnuradio-limesuiteng plugin for GNURadio can also be built using conda recipe. To build the plugin, LimeSuiteNG conda package must be built and installed inside the current conda environment. Plugin recipe files are provided in ``<project>\plugins\gr-limesuiteng\.conda\`` directory. To start the build process, execute the following commands:
1322

1423
.. code-block:: bash
1524
1625
conda activate <custom env name>
1726
cd <repo root>\plugins\gr-limesuiteng
1827
conda-build .conda\recipe\ -m .conda\build_config.yaml
1928
20-
Conda will start building package. After successfull build, conda package is populated in ``<radioconda install dir>\envs\<your custom env>\conda-bld\win-64`` directory with the following name structure ``gnuradio-limesuiteng-version-build_number.conda``.
29+
Conda will start building package. The ``build_config.yaml`` file alongside the ``-m`` flag enables package build from locally stored source code. To build from git ``develop`` branch, omit the flag and arguments. After successfull build, conda package is populated in ``<radioconda install dir>\envs\<your custom env>\conda-bld\win-64`` directory with the following name structure ``gnuradio-limesuiteng-version-build_number.conda``.
2130

2231
.. note::
2332

docs/gettingStarted/plugins/gnuradio/Windows/package.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _gnuradio-plugin-install-ref:
2+
13
Conda package
24
=============
35

0 commit comments

Comments
 (0)