From 116aa44b7699134c85bac63dd194331a789b8fa6 Mon Sep 17 00:00:00 2001 From: akatumalla-ouster <132627369+akatumalla-ouster@users.noreply.github.com> Date: Fri, 4 Oct 2024 15:47:30 -0700 Subject: [PATCH] Update to release/0.13.0 documentation (#615) ## Summary of Changes Hotfix to release 0.13.0 docs, updates github URL. --- CMakeLists.txt | 2 +- LICENSE | 2 +- README.rst | 4 ++-- cmake/FindOusterSDK.cmake | 2 +- conanfile.py | 2 +- docs/conf.py | 2 +- docs/cpp/building.rst | 10 +++++----- docs/cpp/examples/simple_examples.rst | 4 ++-- docs/migration/migration-20230114-20230403.rst | 4 ++-- docs/overview.rst | 8 ++++---- docs/python/devel.rst | 8 ++++---- docs/reference/lidar-scan.rst | 2 +- python/Dockerfile | 2 +- python/README.rst | 2 +- python/setup.cfg | 2 +- python/setup.py | 2 +- 16 files changed, 29 insertions(+), 29 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 05591159..2b13753b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -13,7 +13,7 @@ include(DefaultBuildType) include(VcpkgEnv) # ==== Project Name ==== -project(ouster_sdk VERSION 0.13.0) +project(ouster-sdk VERSION 0.13.0) # generate version header set(OusterSDK_VERSION_STRING 0.13.0) diff --git a/LICENSE b/LICENSE index d154c0f5..d6e599d0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: OusterSDK Upstream-Contact: Ouster Sensor SDK Developers -Source: https://github.com/ouster-lidar/ouster_sdk +Source: https://github.com/ouster-lidar/ouster-sdk Files: * Copyright: 2018-2022 Ouster, Inc diff --git a/README.rst b/README.rst index 53f16eea..1929f057 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -.. figure:: https://github.com/ouster-lidar/ouster_sdk/raw/master/docs/images/Ouster_Logo_TM_Horiz_Black_RGB_600px.png +.. figure:: docs/images/Ouster_Logo_TM_Horiz_Black_RGB_600px.png ------------------------------------------------------ @@ -33,7 +33,7 @@ The submodule cannot be cloned or updated. Contact ======= -For support of the Ouster SDK, please use `Github Issues `_ in this repo. +For support of the Ouster SDK, please use `Github Issues `_ in this repo. For support of Ouster products outside of the SDK, please use `Ouster customer support `_. diff --git a/cmake/FindOusterSDK.cmake b/cmake/FindOusterSDK.cmake index 3bcd2b1f..e107f2a4 100644 --- a/cmake/FindOusterSDK.cmake +++ b/cmake/FindOusterSDK.cmake @@ -1,5 +1,5 @@ # Allow downstream code to depend on source transparently if(NOT TARGET EXAMPLE_INCLUDED) add_custom_target(EXAMPLE_INCLUDED) - add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/.. ouster_sdk EXCLUDE_FROM_ALL) + add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/.. ouster-sdk EXCLUDE_FROM_ALL) endif() diff --git a/conanfile.py b/conanfile.py index e521b07b..f6e92e11 100644 --- a/conanfile.py +++ b/conanfile.py @@ -11,7 +11,7 @@ class ousterSdkRecipe(ConanFile): package_type = "library" license = "BSD 3-Clause License" author = "Ouster, Inc." - url = "https://github.com/ouster-lidar/ouster_sdk" + url = "https://github.com/ouster-lidar/ouster-sdk" description = "Ouster SDK - tools for working with Ouster Lidars" topics = ("lidar", "driver", "hardware", "point cloud", "3d", "robotics", "automotive") settings = "os", "compiler", "build_type", "arch" diff --git a/docs/conf.py b/docs/conf.py index e8b884e5..da7c6b62 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -118,7 +118,7 @@ def parse_version(): html_context = { 'display_github': True, 'github_user': 'ouster-lidar', - 'github_repo': 'ouster_sdk', + 'github_repo': 'ouster-sdk', # 'github_version': 'ouster/python-bindings', 'github_version': 'master', 'conf_py_path': '/docs/', diff --git a/docs/cpp/building.rst b/docs/cpp/building.rst index 59ef127c..5e353e01 100644 --- a/docs/cpp/building.rst +++ b/docs/cpp/building.rst @@ -9,7 +9,7 @@ jsoncpp, Eigen3, and tins libraries with headers installed on the system. The sa requires the GLFW3 and GLEW libraries. The C++ example code is available `on the Ouster Github -`_. Follow the instructions for cloning the project. +`_. Follow the instructions for cloning the project. Building on Linux / macOS ========================= @@ -37,10 +37,10 @@ To build run the following commands: $ mkdir build $ cd build - $ cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=ON + $ cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=ON $ cmake --build . -- -j$(nproc) -where ```` is the location of the ``ouster_sdk`` source directory. The +where ```` is the location of the ``ouster-sdk`` source directory. The CMake build script supports several optional flags. Add any of the following to override the defaults: @@ -84,12 +84,12 @@ You should be able to install dependencies with PS > .\vcpkg.exe install --triplet x64-windows jsoncpp eigen3 curl libtins glfw3 glew spdlog libpng flatbuffers -After these steps are complete, you should be able to open, build and run the ``ouster_sdk`` +After these steps are complete, you should be able to open, build and run the ``ouster-sdk`` project using Visual Studio: 1. Start Visual Studio. 2. When the prompt opens asking you what type of project to open click **Open a local folder** and - navigate to the ``ouster_sdk`` source directory. + navigate to the ``ouster-sdk`` source directory. 3. After opening the project for the first time, wait for CMake configuration to complete. 4. Make sure the ``Desktop development with C++`` is installed. If not, install it using the Search bar on the top of the screen. diff --git a/docs/cpp/examples/simple_examples.rst b/docs/cpp/examples/simple_examples.rst index ce67ab5d..51de31e3 100644 --- a/docs/cpp/examples/simple_examples.rst +++ b/docs/cpp/examples/simple_examples.rst @@ -99,7 +99,7 @@ To see this in action, you can run the example executable ``lidar_scan_example`` $ lidar_scan_example $SAMPLE_DUAL_RETURNS_PCAP $SAMPLE_DUAL_RETURNS_JSON -The source code of ``lidar_scan_example`` is available `here `_. +The source code of ``lidar_scan_example`` is available `here `_. 2D Representations and 3D representations @@ -121,7 +121,7 @@ To run this example: representations_example $SAMPLE_DUAL_RETURNS_PCAP $SAMPLE_DUAL_RETURNS_JSON -The source code of ``representations_example`` is available `on the github `_. +The source code of ``representations_example`` is available `on the github `_. Reshaping XYZ to 2D diff --git a/docs/migration/migration-20230114-20230403.rst b/docs/migration/migration-20230114-20230403.rst index 4cb49c95..55d621e2 100644 --- a/docs/migration/migration-20230114-20230403.rst +++ b/docs/migration/migration-20230114-20230403.rst @@ -77,14 +77,14 @@ Python 3.7 reaches its end of life on June 27th, 2023. We will likely stop produ FW versions ~~~~~~~~~~~ FW 2.0 will be 3 years old in November 2023, with numerous upgrades introduces in subsequent FWs -2.1-2.5, and FW 3.0. New versions of the Python SDK and new commits of ouster_sdk will likely +2.1-2.5, and FW 3.0. New versions of the Python SDK and new commits of ouster-sdk will likely stop supporting direct communication with sensors running FW 2.0 by November 2023, although recorded data in the pcap+json format will continue to be read and supported. Ubuntu 18.04 ~~~~~~~~~~~~ Ubuntu 18.04 reaches its end of standard support in May 2023. We will likely stop supporting the C++ -and Python builds of ``ouster_sdk`` on 18.04 by November 2023. You will still be able to run +and Python builds of ``ouster-sdk`` on 18.04 by November 2023. You will still be able to run available Python wheels on your system if you so choose. diff --git a/docs/overview.rst b/docs/overview.rst index 912d5fe4..d60d14c7 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -93,11 +93,11 @@ announcements`_ .. _Ouster sensor documentation: https://static.ouster.dev/sensor-docs/index.html .. _Ouster support: https://ouster.atlassian.net/servicedesk/customer/portal/8 -.. _Github issue tracker: https://github.com/ouster-lidar/ouster_sdk/issues -.. _Ouster Github announcements: https://github.com/ouster-lidar/ouster_sdk/discussions/categories/announcements -.. _Changelog: https://github.com/ouster-lidar/ouster_sdk/blob/master/CHANGELOG.rst +.. _Github issue tracker: https://github.com/ouster-lidar/ouster-sdk/issues +.. _Ouster Github announcements: https://github.com/ouster-lidar/ouster-sdk/discussions/categories/announcements +.. _Changelog: https://github.com/ouster-lidar/ouster-sdk/blob/master/CHANGELOG.rst .. _Ouster ROS 1 driver: https://github.com/ouster-lidar/ouster-ros -.. _Lifecycle Policies: https://github.com/ouster-lidar/ouster_sdk/discussions/532 +.. _Lifecycle Policies: https://github.com/ouster-lidar/ouster-sdk/discussions/532 .. _OS0: https://ouster.com/products/hardware/os0-lidar-sensor .. _OS1: https://ouster.com/products/hardware/os1-lidar-sensor .. _OS2: https://ouster.com/products/hardware/os2-lidar-sensor diff --git a/docs/python/devel.rst b/docs/python/devel.rst index e03f510b..334f26b6 100644 --- a/docs/python/devel.rst +++ b/docs/python/devel.rst @@ -24,7 +24,7 @@ Building the Python SDK from source requires several dependencies: - `python `_ >= 3.8 (with headers and development libraries) - `pybind11 `_ >= 2.0 -The Python SDK source is available `on the Ouster Github `_. You should clone the whole project. +The Python SDK source is available `on the Ouster Github `_. You should clone the whole project. Linux and macOS --------------- @@ -49,7 +49,7 @@ After you have the system dependencies, you can build the SDK with: .. code:: console - # first, specify the path to the ouster_sdk repository + # first, specify the path to the ouster-sdk repository $ export OUSTER_SDK_PATH= # make sure you have an up-to-date version of pip and setuptools installed @@ -86,7 +86,7 @@ The currently tested vcpkg tag is ``2024.04.26``. After that, using a developer .. code:: powershell - # first, specify the path to the ouster_sdk repository + # first, specify the path to the ouster-sdk repository PS > $env:OUSTER_SDK_PATH="" # point cmake to the location of vcpkg (make sure to use an absolute path) @@ -112,7 +112,7 @@ See the top-level README in the `Ouster Example repository`_ for more details on development environment on Windows. .. _vcpkg: https://github.com/microsoft/vcpkg/blob/master/README.md -.. _Ouster Example repository: https://github.com/ouster-lidar/ouster_sdk +.. _Ouster SDK repository: https://github.com/ouster-lidar/ouster-sdk Developing diff --git a/docs/reference/lidar-scan.rst b/docs/reference/lidar-scan.rst index 381a524c..e3315516 100644 --- a/docs/reference/lidar-scan.rst +++ b/docs/reference/lidar-scan.rst @@ -260,4 +260,4 @@ both sampling, used in :ref:`ex-visualization-with-matplotlib`, and streaming, u Under the hood, this class batches packets into ``LidarScans``. C++ users must batch packets themselves using the :cpp:class:`ouster::ScanBatcher` class. To get a feel for how to use it, we recommend reading `this example on GitHub -`_. +`_. diff --git a/python/Dockerfile b/python/Dockerfile index 795dde6a..d6f87122 100644 --- a/python/Dockerfile +++ b/python/Dockerfile @@ -47,7 +47,7 @@ RUN set -xe \ USER build:build ENV PATH="${PATH}:${BUILD_HOME}/.local/bin" \ - OUSTER_SDK_PATH="/opt/ouster_sdk" + OUSTER_SDK_PATH="/opt/ouster-sdk" WORKDIR ${BUILD_HOME} # Populate source dir diff --git a/python/README.rst b/python/README.rst index 80768daa..a5585c60 100644 --- a/python/README.rst +++ b/python/README.rst @@ -51,7 +51,7 @@ follow our `Lifecycle Policy`_ page to understand when support for a Python vers Operating System, or Sensor FW may dropped from support. .. _PyPI: https://pypi.org/project/ouster-sdk/ -.. _Lifecycle Policy: https://github.com/ouster-lidar/ouster_sdk/discussions/532 +.. _Lifecycle Policy: https://github.com/ouster-lidar/ouster-sdk/discussions/532 .. [python-supported-platforms-end] diff --git a/python/setup.cfg b/python/setup.cfg index 63882351..4432f508 100644 --- a/python/setup.cfg +++ b/python/setup.cfg @@ -3,7 +3,7 @@ long_description = file: README.rst long_description_content_type = text/x-rst project_urls = Ouster SDK Documentation = https://static.ouster.dev/sdk-docs/index.html - Bug Tracker = https://github.com/ouster-lidar/ouster_sdk/issues + Bug Tracker = https://github.com/ouster-lidar/ouster-sdk/issues Ouster Customer Support = https://ouster.atlassian.net/servicedesk/customer/portal/8 classifiers = Development Status :: 3 - Alpha diff --git a/python/setup.py b/python/setup.py index 9cecfb0f..ebed9cb0 100644 --- a/python/setup.py +++ b/python/setup.py @@ -181,7 +181,7 @@ def install_requires(): if __name__ == "__main__": setup( name='ouster-sdk', - url='https://github.com/ouster-lidar/ouster_sdk', + url='https://github.com/ouster-lidar/ouster-sdk', # read from top-level sdk CMakeLists.txt version=parse_version(), package_dir={'': 'src'},