xrprimer
OpenXRLab foundational library for XR-related algorithms
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 6 committers (16.7%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (18.7%) to scientific vocabulary
Repository
OpenXRLab foundational library for XR-related algorithms
Basic Info
- Host: GitHub
- Owner: openxrlab
- License: other
- Language: C++
- Default Branch: main
- Homepage: https://xrprimer.readthedocs.io/en/latest/
- Size: 624 KB
Statistics
- Stars: 87
- Watchers: 1
- Forks: 19
- Open Issues: 6
- Releases: 2
Metadata Files
README.md
Introduction
English | 简体中文
XRPrimer is a fundational library for XR-related algorithms. The XRPrimer provides reusable data structures, efficient operaters and extensible interfaces both in C++ and Python.
Major Features
- [x] Various camera models and conversion tools (Pinhole, Fisheye, Omni etc.)
- [x] Basic 3D operations (Triangulation, Projection etc.)
- [x] Multi-camera extrinsic calibration tools
- [ ] Rendering and visualization tools
Operation Systems
It currently supports the following systems.
- Linux
- iOS
Installation
Python
If using xrprimer in a Python project, it can be installed by:
bash
pip install xrprimer
If you want to use the latest updates of xrprimer, please refer to Python Installation for detailed installation.
C++
If using xrprimer in a C++ project, please refer to C++ Installation for compilation and test.
Getting started
Use XRPrimer in Python projects
The below code is supposed to run successfully upon you finish the installation.
bash
python -c "import xrprimer; print(xrprimer.__version__)"
Use XRPrimer in C++ projects
An example is given below to show how to link xrprimer in C++ projects. More details can be found here.
```js cmakeminimumrequired(VERSION 3.16)
project(sample)
set path for find XRPrimer package (config mode)
set(XRPrimerDIR "<packagepath>/lib/cmake") find_package(XRPrimer REQUIRED)
add_executable(sample sample.cpp)
targetlinklibraries(sample XRPrimer::xrprimer) ```
FAQ
If you face some installation issues, you may first refer to this Frequently Asked Questions.
License
The license of our codebase is Apache-2.0. Note that this license only applies to code in our library, the dependencies of which are separate and individually licensed. We would like to pay tribute to open-source implementations to which we rely on. Please be aware that using the content of dependencies may affect the license of our codebase. Refer to LICENSE to view the full license.
Citation
If you find this project useful in your research, please consider cite:
bibtex
@misc{xrprimer,
title={OpenXRLab Foundational Library for XR-related Algorithms},
author={XRPrimer Contributors},
howpublished = {\url{https://github.com/openxrlab/xrprimer}},
year={2022}
}
Contributing
We appreciate all contributions to improve XRPrimer. Please refer to CONTRIBUTING.md for the contributing guideline.
Acknowledgement
XRPrimer is an open source project that is contributed by researchers and engineers from both the academia and the industry. We appreciate all the contributors who implement their methods or add new features, as well as users who give valuable feedbacks. We wish that the toolbox and benchmark could serve the growing research community by providing a flexible toolkit to reimplement existing methods and develop their own new models.
Projects in OpenXRLab
- XRPrimer: OpenXRLab foundational library for XR-related algorithms.
- XRSLAM: OpenXRLab Visual-inertial SLAM Toolbox and Benchmark.
- XRSfM: OpenXRLab Structure-from-Motion Toolbox and Benchmark.
- XRLocalization: OpenXRLab Visual Localization Toolbox and Server.
- XRMoCap: OpenXRLab Multi-view Motion Capture Toolbox and Benchmark.
- XRMoGen: OpenXRLab Human Motion Generation Toolbox and Benchmark.
- XRNeRF: OpenXRLab Neural Radiance Field (NeRF) Toolbox and Benchmark.
- XRFeitoria: OpenXRLab Synthetic Data Rendering Toolbox.
- XRViewer: OpenXRLab Data Visualization Toolbox.
- XRTailor: OpenXRLab GPU Cloth Simulator.
Owner
- Name: OpenXRLab
- Login: openxrlab
- Kind: organization
- Website: https://openxrlab.org.cn/
- Twitter: OpenXRLab
- Repositories: 11
- Profile: https://github.com/openxrlab
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - name: "XRPrimer Contributors" title: "XRPrimer: OpenXRLab foundational library for XR-related algorithms" date-released: 2022-09-01 url: "https://github.com/openxrlab/xrprimer" license: Apache-2.0
GitHub Events
Total
- Watch event: 5
- Push event: 1
- Pull request review event: 3
- Pull request event: 2
- Fork event: 5
- Create event: 1
Last Year
- Watch event: 5
- Push event: 1
- Pull request review event: 3
- Pull request event: 2
- Fork event: 5
- Create event: 1
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| yl-1993 | y****v@g****m | 21 |
| LazyBusyYang | g****n@o****m | 20 |
| GACLove | p****c@g****m | 15 |
| LazyBusyYang | g****3@s****m | 7 |
| Mei | h****i@m****n | 1 |
| YANG | e****t@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 16
- Total pull requests: 33
- Average time to close issues: 2 months
- Average time to close pull requests: 7 days
- Total issue authors: 12
- Total pull request authors: 7
- Average comments per issue: 1.19
- Average comments per pull request: 0.76
- Merged pull requests: 27
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: 6 days
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 1.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- aichunling0418 (3)
- sxlyiyiyi (2)
- Taylorminer (2)
- ccctw-ma (1)
- photoncanon (1)
- wangni-bupt (1)
- Frizy-up (1)
- pablovela5620 (1)
- zuofy (1)
- GACLove (1)
- antithing (1)
- luyihsien (1)
Pull Request Authors
- LazyBusyYang (11)
- yl-1993 (8)
- GACLove (5)
- WYK96 (2)
- ruitard (2)
- Maoxie (1)
- HaiyiMei (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 224 last-month
- Total dependent packages: 1
- Total dependent repositories: 3
- Total versions: 7
- Total maintainers: 3
pypi.org: xrprimer
description
- Documentation: https://xrprimer.readthedocs.io/en/latest/
- License: Apache License 2.0
-
Latest release: 0.7.1
published almost 3 years ago
Rankings
Maintainers (3)
Dependencies
- numpy *
- scipy *
- coverage * test
- interrogate * test
- numpy * test
- opencv-python-headless * test
- pre-commit * test
- pytest * test
- actions/checkout v2 composite
- codecov/codecov-action v3 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- docutils ==0.16.0
- myst-parser *
- sphinx ==4.0.2
- sphinx-copybutton *
- sphinx_markdown_tables *
- sphinx_rtd_theme ==0.5.2
- numpy *
- opencv-python *
- quay.io/pypa/manylinux2014_x86_64 latest build
- ubuntu 18.04 build
- imath *
- numpy *
- openexr *
- scipy *
- matplotlib *
- opencv-python *