Skip to content

Commit a8143cb

Browse files
authored
Update MANIFEST to yaml format and install examples to discoverable dir (#131)
* Update MANIFEST to yaml format and install examples to discoverable dir * Add gitattributes so pybind11 header hash check works on Windows * Update recipe for new example path
1 parent 9befbad commit a8143cb

File tree

5 files changed

+35
-6
lines changed

5 files changed

+35
-6
lines changed

.conda/recipe/meta.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ test:
8686
# verify that examples get installed
8787
{% set example_grcs = ["lora_RX", "lora_TX", "tx_rx_functionality_check", "tx_rx_simulation", "tx_rx_usrp"] %}
8888
{% for eg in example_grcs %}
89-
- grcc $PREFIX/share/gr-{{ oot_name }}/examples/{{ eg }}.grc # [not win]
90-
- grcc %PREFIX%\\Library\\share\\gr-{{ oot_name}}\\examples\\{{ eg }}.grc # [win]
89+
- grcc $PREFIX/share/gnuradio/examples/{{ oot_name }}/{{ eg }}.grc # [not win]
90+
- grcc %PREFIX%\\Library\\share\\gnuradio\\examples\\{{ oot_name }}\\{{ eg }}.grc # [win]
9191
{% endfor %}
9292

9393
imports:
@@ -117,10 +117,10 @@ about:
117117
- (Windows) `%CONDA_PREFIX%\share\gr-lora_sdr\examples`
118118
<br>
119119
If you find this module useful for your project, please consider citing the
120-
publication "An Open-Source LoRa Physical Layer Prototype on GNU Radio"
121-
(<a href="https://ieeexplore.ieee.org/document/9154273">IEEE Xplore</a>,
120+
publication "An Open-Source LoRa Physical Layer Prototype on GNU Radio"
121+
(<a href="https://ieeexplore.ieee.org/document/9154273">IEEE Xplore</a>,
122122
<a href="https://arxiv.org/abs/2002.08208">arXiv</a>)
123123
<h3>Installation issue</h3>
124124
Add conda-forge to the list of channel for installation with:<br>
125125
`conda install -c tapparelj -c conda-forge gnuradio-lora_sdr`
126-
126+

.gitattributes

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# In GNU Radio 3.9+, pybind11 compares hash values of headers and source
2+
# files against knowns values. Conversion of values to CRLF on checkout
3+
# break those checks so keep LF values when files are subject to said checks
4+
#
5+
*.h text eol=lf
6+
*.c text eol=lf
7+
*.cc text eol=lf

CMakeLists.txt

+3
Original file line numberDiff line numberDiff line change
@@ -166,3 +166,6 @@ configure_package_config_file(
166166
INSTALL_DESTINATION ${GR_CMAKE_DIR}
167167
)
168168

169+
install(FILES MANIFEST.yml
170+
RENAME MANIFEST-${VERSION_MAJOR}.${VERSION_API}.${VERSION_ABI}${VERSION_PATCH}.yml
171+
DESTINATION share/gnuradio/manifests/lora_sdr)

MANIFEST.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
title: The LORA_SDR OOT Module
2+
version: 1.0
3+
brief: OOT Module containing all blocks requiring for a functional LoRa transceiver
4+
tags: # Tags are arbitrary, but look at CGRAN what other authors are using
5+
- SDR
6+
- LoRa
7+
author:
8+
- Tapparel Joachim <joachim.tapparel@epfl.ch>
9+
copyright_owner:
10+
- Tapparel Joachim
11+
license: GPL-3.0-or-later
12+
gr_supported_version:
13+
- 3.10
14+
repo: https://github.com/tapparelj/gr-lora_sdr
15+
website: https://github.com/tapparelj/gr-lora_sdr
16+
#icon: # Put a URL to a square image here that will be used as an icon
17+
description: |-
18+
This is the fully-functional GNU Radio software-defined radio (SDR) implementation of a LoRa transceiver with all the necessary receiver components to operate correctly even at very low SNRs. The transceiver is available as a module for GNU Radio 3.10. This work has been conducted at the Telecommunication Circuits Laboratory, EPFL.
19+
file_format: 1

examples/CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ install(
1010
tx_rx_hier_functionality_check.grc
1111
tx_rx_simulation.grc
1212
tx_rx_usrp.grc
13-
DESTINATION ${GR_PKG_DATA_DIR}/examples)
13+
DESTINATION share/gnuradio/examples/lora_sdr)

0 commit comments

Comments
 (0)