From a15d6bb34f816a612e99f93bfeea1318bf6f9fc0 Mon Sep 17 00:00:00 2001 From: Ryan Volz Date: Tue, 18 Jul 2023 16:02:43 -0400 Subject: [PATCH] Add conda recipe --- .conda/README.md | 110 ++++++++++++++++++++++++++ .conda/conda-forge.yml | 34 ++++++++ .conda/recipe/bld.bat | 29 +++++++ .conda/recipe/build.sh | 22 ++++++ .conda/recipe/conda_build_config.yaml | 14 ++++ .conda/recipe/meta.yaml | 88 +++++++++++++++++++++ 6 files changed, 297 insertions(+) create mode 100644 .conda/README.md create mode 100644 .conda/conda-forge.yml create mode 100644 .conda/recipe/bld.bat create mode 100644 .conda/recipe/build.sh create mode 100644 .conda/recipe/conda_build_config.yaml create mode 100644 .conda/recipe/meta.yaml diff --git a/.conda/README.md b/.conda/README.md new file mode 100644 index 0000000..8a2dce0 --- /dev/null +++ b/.conda/README.md @@ -0,0 +1,110 @@ +# gr-foo conda recipe + +This recipe is for creating a package that can be installed into a [conda](https://docs.conda.io/en/latest/) environment. See the [Conda GNU Radio Guide](https://wiki.gnuradio.org/index.php/CondaInstall) for more information on using GNU Radio with conda. + +Packages for GNU Radio and some out-of-tree (OOT) modules are available through the [`conda-forge` channel](https://conda-forge.org/). If this OOT module is already available (search "gnuradio" on [anaconda.org](https://anaconda.org)), it is preferable to use that existing package rather than this recipe. + +#### Users + +- [Building the package](#building-the-package) + +#### Developers + +- [Modifying the recipe](#modifying-the-recipe) +- [Continuous integration](#continuous-integration) + + +## Building the package + +(See the [Conda GNU Radio Guide](https://wiki.gnuradio.org/index.php/CondaInstall) if you are unfamiliar with how to use conda.) + +1. Make sure that have `conda-build` and `conda-forge-pinning` installed and updated in your base environment: + + conda activate base + conda install -n base conda-build conda-forge-pinning + conda upgrade -n base conda-build conda-forge-pinning + + **Windows users only**: you will also need to have Microsoft's Visual C++ build tools installed. Usually you can do this by installing the [Community edition of Visual Studio](https://visualstudio.microsoft.com/free-developer-offers/) and then selecting a MSVC C++ x64/x86 build tools component under the list of "Individual Components". As of this writing, you will specifically need MSVC v141, i.e. the "MSVC v141 - VS2017 C++ x64/x86 build tools (v14.16)" component. If the build fails to find the version of MSVC it is looking for, try installing other (newer) versions. + +2. Download the source code for this OOT module (which includes this recipe). Typically, this is done by using `git` and cloning the module's repository: + + git clone + cd + +3. Run `conda-build` on the recipe to create the package: + + (Linux and macOS) + + conda build .conda/recipe/ -m ${CONDA_PREFIX}/conda_build_config.yaml + + (Windows) + + conda build .conda\recipe\ -m %CONDA_PREFIX%\conda_build_config.yaml + + If you plan on using this package within an existing environment which uses a specific version of Python, specify the version of Python using the `--python` flag. You must use a version string that matches one of the strings listed under `python` in the `${CONDA_PREFIX}/conda_build_config.yaml` file, e.g: + + (Linux and macOS) + + conda build .conda/recipe/ -m ${CONDA_PREFIX}/conda_build_config.yaml --python="3.9.* *_cpython" + + (Windows) + + conda build .conda\recipe\ -m %CONDA_PREFIX%\conda_build_config.yaml --python="3.9.* *_cpython" + + If you encounter errors, consult with the OOT module maintainer or the maintainers of the [gnuradio feedstock](https://github.com/conda-forge/gnuradio-feedstock). It is possible that the recipe will need to be updated. + +4. Install the package into an existing environment + + conda install --use-local -n gnuradio-EXAMPLE + + or create a new environment that includes the package: + + conda create -n test_env gnuradio-EXAMPLE + + +## Modifying the recipe + +This recipe is derived from a template, and so it is best to check it and make any necessary modifications. Likely changes include: + +- Populating metadata near the bottom of the `recipe/meta.yaml` file +- Adding "host" (build-time) and "run" (run-time) dependencies specific to your module in `recipe/meta.yaml` +- Adding special configuration flags or steps are necessary to carry out the build to the build scripts (`recipe/build.sh` for Linux/macOS and `recipe/bld.bat` for Windows) + +Specifying the versions of GNU Radio that your OOT is compatible with is one of the most important modifications. Following the instructions below, the module will be built against the conda-forge "pinned" version of GNU Radio, which is usually the latest version. + +- To override the pinned version of GNU Radio (e.g. for a branch that builds against an older version), specify the `gnuradio_core` key as instructed in `recipe/conda_build_config.yaml`. +- If the module is compatible with multiple major versions of GNU Radio, and you want to build against multiple of them, you can also add extra versions to `recipe/conda_build_config.yaml` to expand the default build matrix. + +See the [conda-build documentation](https://docs.conda.io/projects/conda-build/en/latest/index.html) for details on how to write a conda recipe. + + +## Continuous integration + +Only a few steps are needed to use this recipe to build and test this OOT module using CI services. It can also be used to upload packages to [anaconda.org](https://anaconda.org) for others to download and use. + +1. Make sure that have `conda-smithy` installed in your base conda environment: + + conda activate base + conda install -n base conda-smithy + conda upgrade -n base conda-smithy + +2. Make any changes to the recipe and `conda-forge.yml` that are necessary. For example, if you plan on uploading packages to your own [anaconda.org](https://anaconda.org) channel, specify the channel name and label as the `channel_targets` key in `recipe/conda_build_config.yaml`. Commit the changes to your repository: + + git commit -a + +3. "Re-render" the CI scripts by running conda-smithy from the root of your repository: + + conda-smithy rerender --feedstock_config .conda/conda-forge.yml -c auto + + This will create a commit that adds or updates the CI scripts that have been configured with `conda-forge.yml`. If you want to minimize extraneous files, you can remove some of the newly-created files that are not necessary outside of a typical conda-forge feedstock: + + git rm -f .github/workflows/automerge.yml .github/workflows/webservices.yml .circleci/config.yml + git commit --amend -s + + When the CI is executed (on a pull request or commit), it will run one job per configuration file in `.ci_support` to build packages for various platforms, Python versions, and optionally `gnuradio` versions (by adding to `gnuradio_extra_pin` in `recipe/conda_build_config.yaml`). + + **You should repeat this step whenever the recipe is updated or when changes to the conda-forge infrastructure require all CI scripts to be updated.** + + Since the newly created files will be rewritten whenever conda-smithy is run, you should not edit any of the automatically-generated files in e.g. `.ci_support`, `.scripts`, or `.github/workflows/conda-build.yml`. + +4. (optional) If you want to enable uploads of the packages to [anaconda.org](https://anaconda.org) whenever the CI is run from a commit on the branch specified in `conda-forge.yml`, you need to set an Anaconda Cloud API token to the `BINSTAR_TOKEN` environment variable. To generate a token, follow the instructions [here](https://docs.anaconda.com/anacondaorg/user-guide/tasks/work-with-accounts/#creating-access-tokens). To populate the `BINSTAR_TOKEN` environment variable for CI jobs, add the token as a secret by following, for example, the [Github docs](https://docs.github.com/en/actions/reference/encrypted-secrets). diff --git a/.conda/conda-forge.yml b/.conda/conda-forge.yml new file mode 100644 index 0000000..68b3ea8 --- /dev/null +++ b/.conda/conda-forge.yml @@ -0,0 +1,34 @@ +# See https://conda-forge.org/docs/maintainer/conda_forge_yml.html for +# documentation on possible keys and values. + +# uncomment to enable cross-compiled osx-arm64 builds +build_platform: + linux_aarch64: linux_64 + linux_ppc64le: linux_64 + osx_arm64: osx_64 +clone_depth: 0 +conda_build: + pkg_format: '2' +github_actions: + store_build_artifacts: true +os_version: + linux_64: cos7 +provider: + linux: github_actions + osx: github_actions + win: github_actions + # uncomment to enable additional linux platforms + #linux_aarch64: github_actions + #linux_ppc64le: github_actions +recipe_dir: .conda/recipe +# skip unnecessary files since this is not a full-fledged conda-forge feedstock +skip_render: + - README.md + - LICENSE.txt + - .gitattributes + - .gitignore + - build-locally.py + - LICENSE +test: native_and_emulated +# enable uploads to Anaconda Cloud from specified branches only +upload_on_branch: main diff --git a/.conda/recipe/bld.bat b/.conda/recipe/bld.bat new file mode 100644 index 0000000..de4a3b7 --- /dev/null +++ b/.conda/recipe/bld.bat @@ -0,0 +1,29 @@ +setlocal EnableDelayedExpansion +@echo on + +:: Make a build folder and change to it +cmake -E make_directory buildconda +cd buildconda + +:: configure +cmake -G "Ninja" ^ + -DCMAKE_BUILD_TYPE:STRING=Release ^ + -DCMAKE_INSTALL_PREFIX:PATH="%LIBRARY_PREFIX%" ^ + -DCMAKE_PREFIX_PATH:PATH="%LIBRARY_PREFIX%" ^ + -DGR_PYTHON_DIR:PATH="%SP_DIR%" ^ + -DENABLE_DOXYGEN=OFF ^ + -DENABLE_TESTING=ON ^ + .. +if errorlevel 1 exit 1 + +:: build +cmake --build . --config Release -- -j%CPU_COUNT% +if errorlevel 1 exit 1 + +:: install +cmake --build . --config Release --target install +if errorlevel 1 exit 1 + +:: test +ctest --build-config Release --output-on-failure --timeout 120 -j%CPU_COUNT% +if errorlevel 1 exit 1 diff --git a/.conda/recipe/build.sh b/.conda/recipe/build.sh new file mode 100644 index 0000000..2f3df70 --- /dev/null +++ b/.conda/recipe/build.sh @@ -0,0 +1,22 @@ +#!/usr/bin/env bash + +set -ex + +cmake -E make_directory buildconda +cd buildconda + +cmake_config_args=( + -DCMAKE_BUILD_TYPE=Release + -DCMAKE_INSTALL_PREFIX=$PREFIX + -DLIB_SUFFIX="" + -DENABLE_DOXYGEN=OFF + -DENABLE_TESTING=ON +) + +cmake ${CMAKE_ARGS} -G "Ninja" .. "${cmake_config_args[@]}" +cmake --build . --config Release -- -j${CPU_COUNT} +cmake --build . --config Release --target install + +if [[ "${CONDA_BUILD_CROSS_COMPILATION:-}" != "1" || "${CROSSCOMPILING_EMULATOR}" != "" ]]; then + ctest --build-config Release --output-on-failure --timeout 120 -j${CPU_COUNT} +fi diff --git a/.conda/recipe/conda_build_config.yaml b/.conda/recipe/conda_build_config.yaml new file mode 100644 index 0000000..ce9c0f6 --- /dev/null +++ b/.conda/recipe/conda_build_config.yaml @@ -0,0 +1,14 @@ +# this is the channel and label where packages will be uploaded to if enabled +# (see ../README.md) +channel_targets: + - gnuradio main +# override the conda-forge pin for gnuradio-core by uncommenting +# and specifying a different version here +#gnuradio_core: + #- "3.10.1" +gnuradio_extra_pin: + # always leave one entry with the empty string + - "" + # add version strings here like to get builds for versions other than + # the conda-forge-wide default or version specified above for gnuradio_core + #- "3.9.5" diff --git a/.conda/recipe/meta.yaml b/.conda/recipe/meta.yaml new file mode 100644 index 0000000..de60f53 --- /dev/null +++ b/.conda/recipe/meta.yaml @@ -0,0 +1,88 @@ +{% set oot_name = "foo" %} +{% set name = "gnuradio-" + oot_name %} +# Set package version from cleaned up git tags if possible, +# otherwise fall back to date-based version. +{% set tag_version = environ.get("GIT_DESCRIBE_TAG", "")|string|replace("-","_")|replace("v","")|replace("git","") %} +{% set post_commit = environ.get("GIT_DESCRIBE_NUMBER", 0)|string %} +{% set hash = environ.get("GIT_DESCRIBE_HASH", "local")|string %} +{% set fallback_version = "0.0.0.{0}.dev+g{1}".format(datetime.datetime.now().strftime("%Y%m%d"), environ.get("GIT_FULL_HASH", "local")[:9]) %} +{% set version = (tag_version if post_commit == "0" else "{0}.post{1}+{2}".format(tag_version, post_commit, hash)) if tag_version else fallback_version %} + +package: + name: {{ name|lower }} + version: {{ version }} + +source: + # use local path or git repository depending on if the build is local or done on CI + path: "../.." # [not os.environ.get("CI")] + git_url: {{ environ.get('FEEDSTOCK_ROOT', "../..") }} # [os.environ.get("CI")] + +build: + number: 0 + run_exports: + - {{ pin_subpackage('gnuradio-foo', max_pin='x.x.x') }} + +requirements: + build: + - {{ compiler("c") }} + - {{ compiler("cxx") }} + - cmake + - git + - ninja + - pkg-config + # cross-compilation requirements + - python # [build_platform != target_platform] + - cross-python_{{ target_platform }} # [build_platform != target_platform] + - numpy # [build_platform != target_platform] + - pybind11 # [build_platform != target_platform] + + host: + - boost-cpp + - gmp # [linux] + # the following two entries are for generating builds against specific GR versions + - gnuradio-core # [not gnuradio_extra_pin] + - gnuradio-core {{ gnuradio_extra_pin }}.* # [gnuradio_extra_pin] + - pip # [win] + - pybind11 + - python + - numpy + - uhd + + run: + - boost-cpp + - numpy + - python + +test: + commands: + # verify that (some) headers get installed + - test -f $PREFIX/include/{{ oot_name }}/api.h # [not win] + - if not exist %PREFIX%\\Library\\include\\{{ oot_name }}\\api.h exit 1 # [win] + + # verify that libraries get installed + - test -f $PREFIX/lib/lib{{ name }}${SHLIB_EXT} # [not win] + - if not exist %PREFIX%\\Library\\bin\\{{ name }}.dll exit 1 # [win] + - if not exist %PREFIX%\\Library\\lib\\{{ name }}.lib exit 1 # [win] + + # verify that (some) GRC blocks get installed + {% set blocks = ["burst_tagger", "channel_model", "packet_dropper", "packet_pad", "packet_pad2", "pad_tagged_stream", "periodic_msg_source", "random_periodic_msg_source", "selector", "valve", "wireshark_connector"] %} + {% for block in blocks %} + - test -f $PREFIX/share/gnuradio/grc/blocks/{{ oot_name }}_{{ block }}.block.yml # [not win] + - if not exist %PREFIX%\\Library\\share\\gnuradio\\grc\\blocks\\{{ oot_name }}_{{ block }}.block.yml exit 1 # [win] + {% endfor %} + + imports: + # verify that the python module imports + - {{ oot_name }} + +about: + home: https://github.com/bastibl/gr-foo + license: GPL-3.0-or-later + license_file: LICENSE + summary: Collection of GNU Radio blocks useful to other modules + description: > + This is a collection of custom blocks that are not directly associated with + a project. For sample applications see: + + * https://github.com/bastibl/gr-ieee802-11 + * https://github.com/bastibl/gr-ieee802-15-4