Skip to content

Commit 5d9e75c

Browse files
committed
Release 1.0.0, 24.04.
0 parents  commit 5d9e75c

File tree

195 files changed

+20590
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

195 files changed

+20590
-0
lines changed

.dockerignore

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.git
2+
# Python cache
3+
.pytest_cache
4+
__pycache__
5+
# cache
6+
.cache
7+
# build folders
8+
build*
9+
*.egg-info
10+
# tao peoplenet files
11+
*.fp16
12+
*.onnx
13+
# NSight profiler files
14+
*.ncu-rep
15+
*.nsys-rep

.flake8

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[flake8]
2+
max-line-length=88

.gitattributes

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
**/*.pcap filter=lfs diff=lfs merge=lfs -text
2+
**/*.pdf filter=lfs diff=lfs merge=lfs -text
3+
**/*.png filter=lfs diff=lfs merge=lfs -text
4+
.gitlab-ci.yml export-ignore
5+
RELEASE.sh export-ignore

.gitignore

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
__pycache__
2+
.cache
3+
*.swp
4+
ci/coverage.xml
5+
dist
6+
tags
7+
cscope.*
8+
# cache
9+
.cache
10+
# build folders
11+
*.egg-info
12+
# tao peoplenet files
13+
*.fp16
14+
*.onnx
15+
# NSight profiler files
16+
*.ncu-rep
17+
*.nsys-rep

CMakeLists.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
# SPDX-License-Identifier: Apache-2.0
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
cmake_minimum_required(VERSION 3.20)
17+
18+
project(hololink)
19+
20+
find_package(holoscan 0.6 REQUIRED CONFIG PATHS "/opt/nvidia/holoscan")
21+
22+
# add CMAKE_MODULE_PATH for pybind11_add_hololink_module
23+
list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
24+
25+
if(NOT CMAKE_INSTALL_LIBDIR)
26+
set(CMAKE_INSTALL_LIBDIR lib)
27+
endif()
28+
29+
add_subdirectory(src)
30+
add_subdirectory(python)

CONTRIBUTING.md

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Contributing to Holoscan Sensor Bridge
2+
3+
## Table of Contents
4+
5+
- [Introduction](#introduction)
6+
- [Types of Contributions](#types-of-contributions)
7+
- [Developer Workflow](#developer-workflow)
8+
- [Preparing your submission](#preparing-your-submission)
9+
- [Reporting issues](#reporting-issues)
10+
11+
## Introduction
12+
13+
Welcome to Holoscan Sensor Bridge! Please read our [README](./README.md) document for an
14+
overview of the project.
15+
16+
Please read this guide if you are interested in contributing open source code to
17+
Holoscan Sensor Bridge.
18+
19+
## Types of Contributions
20+
21+
Before getting started, assess how your idea or project may best benefit the Holoscan
22+
community.
23+
24+
If your code is:
25+
26+
- _feature-complete and tested_: Submit a
27+
[pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
28+
to contribute your work to Holoscan Sensor Bridge.
29+
- _a work in progress:_ We recommend to
30+
[fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
31+
Holoscan Sensor Bridge and track your local development there, then submit to Holoscan
32+
Sensor Bridge when ready. Alternatively, open pull request and indicate that it is a
33+
"work-in-progress" with the prefix "WIP".
34+
- _a patch for an existing application or operator_: Submit a
35+
[pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
36+
and request a review from the original author of the contribution you are patching.
37+
38+
We recommend referring to contributing guidelines for testing and styling goals
39+
throughout your development process.
40+
41+
## Developer Workflow
42+
43+
### Requirements
44+
45+
We recommend that new developers review GitHub's
46+
[starting documentation](https://docs.github.com/en/get-started/start-your-journey)
47+
before making their first contribution.
48+
49+
### Workflow
50+
51+
1. Developers must first [fork](https://help.github.com/en/articles/fork-a-repo) the
52+
\[upstream\](https://github.com/nvidia-holoscan/holoscan-sensor-bridge) Holoscan
53+
Sensor Bridge repository.
54+
55+
1. Git clone the forked repository and push changes to the personal fork.
56+
57+
```bash
58+
git clone https://github.com/YOUR_USERNAME/YOUR_FORK.git
59+
# Checkout the targeted branch and commit changes
60+
# Push the commits to a branch on the fork (remote).
61+
git push -u origin <local-branch>:<remote-branch>
62+
```
63+
64+
1. All code submissions must be formatted according to the rules in `ci/lint.sh`. You
65+
can run `ci/lint.sh --format` to automatically format all C++, Python, and Markdown
66+
files-- usually that's enough to get `ci/lint.sh` to pass.
67+
68+
1. Once the code changes are staged on the fork and ready for review, please
69+
[submit](https://help.github.com/en/articles/creating-a-pull-request) a
70+
[Pull Request](https://help.github.com/en/articles/about-pull-requests) (PR) to merge
71+
the changes from a branch of the fork into a selected branch of upstream.
72+
73+
- Exercise caution when selecting the source and target branches for the PR.
74+
- Creation of a PR creation kicks off the [code review](#preparing-your-submission)
75+
process.
76+
77+
1. Holoscan Sensor Bridge maintainers will review the PR and accept the proposal if
78+
changes meet Holoscan Sensor Bridge standards.
79+
80+
Thanks in advance for your patience as we review your contributions. We do appreciate
81+
them!
82+
83+
### License Guidelines
84+
85+
- Make sure that you can contribute your work to open source. Verify that no license
86+
and/or patent conflict is introduced by your code. NVIDIA is not responsible for
87+
conflicts resulting from community contributions.
88+
89+
- We encourage community submissions under the Apache 2.0 permissive open source
90+
license, which is the [Holoscan Sensor Bridge License](./LICENSE).
91+
92+
- We require that members [sign](#signing-your-contribution) their contributions to
93+
certify their work.
94+
95+
### Coding Guidelines
96+
97+
- All source code contributions must strictly adhere to the Holoscan Sensor Bridge
98+
coding style.
99+
100+
### Signing Your Contribution
101+
102+
- We require that all contributors "sign-off" on their commits. This certifies that the
103+
contribution is your original work, or you have rights to submit it under the same
104+
license, or a compatible license.
105+
106+
- Any contribution which contains commits that are not Signed-Off will not be accepted.
107+
108+
- To sign off on a commit you simply use the `--signoff` (or `-s`) option when
109+
committing your changes:
110+
111+
```bash
112+
$ git commit -s -m "Add cool feature."
113+
```
114+
115+
This will append the following to your commit message:
116+
117+
```
118+
Signed-off-by: Your Name <[email protected]>
119+
```
120+
121+
- Full text of the DCO:
122+
123+
```
124+
Developer Certificate of Origin
125+
Version 1.1
126+
127+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
128+
1 Letterman Drive
129+
Suite D4700
130+
San Francisco, CA, 94129
131+
132+
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
133+
```
134+
135+
```
136+
Developer's Certificate of Origin 1.1
137+
138+
By making a contribution to this project, I certify that:
139+
140+
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
141+
142+
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
143+
144+
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
145+
146+
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
147+
```
148+
149+
## Reporting issues
150+
151+
Please open a
152+
[Holoscan Sensor Bridge Issue Request](https://github.com/nvidia-holoscan/holoscan-sensor-bridge/issues)
153+
to request an enhancement, bug fix, or other change in Holoscan Sensor Bridge.

0 commit comments

Comments
 (0)