Skip to content

Commit e159e01

Browse files
runetterunette
authored
Merge pull request #11 from ViRGIS-Team/master
Adding Workflows and Updating README
2 parents a0f1884 + a9ccb80 commit e159e01

Some content is hidden

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

51 files changed

+360
-1723
lines changed

‎.github/workflows/code_style.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Code Style
2+
on: [pull_request]
3+
jobs:
4+
code_style:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v2
8+
- name: Install Astyle
9+
run: sudo apt-get install astyle
10+
- name: Run Astyle
11+
run: ./check_all.bash

‎.github/workflows/linux_test.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Linux Build Test
2+
on:
3+
pull_request
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
10+
- name: Checkout The PR
11+
uses: actions/checkout@v2
12+
13+
- name: Install Conda
14+
uses: conda-incubator/[email protected]
15+
16+
- name: Install PDAL
17+
shell: bash -l {0}
18+
run: conda install -c conda-forge pdal
19+
20+
- name: Build
21+
shell: bash -l {0}
22+
run: |
23+
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DCONDA_BUILD=OFF .
24+
make
25+
make install
26+
27+
- name: Test
28+
shell: bash -l {0}
29+
run: |
30+
ctest -VV
31+

‎.github/workflows/osx_test.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: OSX Build Test
2+
on:
3+
[pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: macos-latest
8+
steps:
9+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
10+
- name: Checkout The PR
11+
uses: actions/checkout@v2
12+
13+
- name: Install Conda
14+
uses: conda-incubator/[email protected]
15+
16+
- name: Install PDAL
17+
shell: bash -l {0}
18+
run: conda install -c conda-forge pdal
19+
20+
- name: Build
21+
shell: bash -l {0}
22+
run: |
23+
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DCONDA_BUILD=OFF .
24+
make
25+
make install
26+
27+
- name: Test
28+
shell: bash -l {0}
29+
run: |
30+
ctest -VV
31+

‎.github/workflows/update_docs.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Update Docs
2+
on:
3+
workflow_dispatch
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
10+
- name: Checkout The PR
11+
uses: actions/checkout@v2
12+
13+
- name: Build
14+
shell: bash
15+
run: |
16+
SOURCE=$(pwd)
17+
cd docs
18+
cat Doxyfile.in | \
19+
sed s:'${PROJECT_NAME}':'pdal-c': | \
20+
sed s:'${pdal-c_VERSION}':'v2.0.0': | \
21+
sed s:'${CMAKE_SOURCE_DIR}':.: | \
22+
sed s:'${PDAL_INCLUDE_DIRS}':NONE: \
23+
> Doxyfile
24+
25+
cat Doxyfile
26+
27+
- name: Run Doxygen
28+
uses: mattnotmitt/[email protected]
29+
with:
30+
doxyfile-path: 'docs/Doxyfile'
31+
32+
- name: Commit files
33+
run: |
34+
git config --local user.email "[email protected]"
35+
git config --local user.name "GitHub Action"
36+
git commit -m "Automatic Documentation Update" -a
37+
38+
- name: Push changes
39+
uses: ad-m/github-push-action@master
40+
with:
41+
github_token: ${{ secrets.GITHUB_TOKEN }}
42+
branch: ${{ github.ref }}
43+
44+
45+
46+
47+

‎.github/workflows/windows_test.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Windows Build Test
2+
on:
3+
[pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: windows-latest
8+
steps:
9+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
10+
- name: Checkout The PR
11+
uses: actions/checkout@v2
12+
13+
- name: Install Conda
14+
uses: conda-incubator/[email protected]
15+
16+
- name: Install PDAL
17+
shell: pwsh
18+
run: conda install -c conda-forge pdal
19+
20+
- name: Build
21+
shell: cmd /C call {0}
22+
run: |
23+
set TOOLCHAIN=""
24+
make.bat
25+
26+
- name: Test
27+
shell: cmd /C call {0}
28+
run: |
29+
cp build\x64-windows\source\pdal\release\pdalc.dll build\x64-windows\tests\pdal\release
30+
cd build\x64-windows\tests\pdal\release
31+
test_pdalc
32+

‎.gitignore‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,13 @@ tests/pdal/test_pdalc_*.c
6363
*.su
6464
*.idb
6565
*.pdb
66+
67+
CMakeFiles/
68+
*.cmake
69+
CMakeCache.txt
70+
Makefile
71+
Data/
72+
Doxyfile
73+
*.tcl
74+
75+
Testing/

‎CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ set(PDALC_ENABLE_TESTS ON CACHE BOOL "Enable pdal-c tests")
2828
set(PDALC_GCC_PARAM_GGC_MIN_HEAPSIZE "131072" CACHE STRING "GCC garbage collection minimum heap size")
2929

3030
include(ObtainProjectVersion)
31+
3132
include_directories("${CMAKE_SOURCE_DIR}/source")
3233

3334
if(CMAKE_COMPILER_IS_GNUCXX)

‎README.md‎

Lines changed: 60 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,69 @@ pdal-c: PDAL C API
22
==================
33

44
[//]: # (@cond Hide build status from Doxygen)
5+
[![Actions Status](https://github.com/ViRGIS-Team/CAPI/workflows/OSX%20Build%20Test/badge.svg)](https://github.com/ViRGIS-Team/CAPI/actions)
6+
[![Actions Status](https://github.com/ViRGIS-Team/CAPI/workflows/Linux%20Build%20Test/badge.svg)](https://github.com/ViRGIS-Team/CAPI/actions)
7+
[![Actions Status](https://github.com/ViRGIS-Team/CAPI/workflows/Windows%20Build%20Test/badge.svg)](https://github.com/ViRGIS-Team/CAPI/actions)
8+
9+
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/pdal-c/badges/version.svg)](https://anaconda.org/conda-forge/pdal-c)
510

6-
[![Build Status](https://travis-ci.com/Simverge/pdal-c.svg?branch=master)](https://travis-ci.com/Simverge/pdal-c)
7-
[![Coverity Scan](https://scan.coverity.com/projects/17631/badge.svg)](https://scan.coverity.com/projects/simverge-pdal-c)
8-
[![SonarCloud](https://sonarcloud.io/api/project_badges/measure?project=Simverge_pdal-c&metric=alert_status)](https://sonarcloud.io/dashboard?id=Simverge_pdal-c)
911

1012
[//]: # (@endcond)
1113

12-
*pdal-c* is a C API for the Point Data Abstraction Library ([PDAL](http:/github.com/PDAL/PDAL))
14+
# Basics
15+
16+
*pdal-c* is a C API for the Point Data Abstraction Library ([PDAL](https:/pdal.io))
1317
and is compatible with PDAL 1.7 and later.
1418

15-
*pdal-c* is released under the [BSD 3-clause license](LICENSE.md).
19+
*pdal-c* is released under the [BSD 3-clause license](LICENSE.md).
20+
21+
# Documentation
22+
23+
[API Documentation](https://pdal.io/CAPI/doxygen/html/index.html)
24+
25+
# Installation
26+
27+
The library can be installed as a package on Windows, Mac and Linux using Conda.
28+
29+
```
30+
conda install -c conda-forge pdal-c
31+
```
32+
33+
## Dependencies
34+
35+
The library is dependent on PDAL and has currently been tested up to v2.2.0.
36+
37+
# Usage
38+
39+
An example of the use of the API is given in the `csharp` folder which contains an integration to PDAL in C#.
40+
41+
NOTE - these scripts are provided for information only as examples and are not supported in any way!
42+
43+
# For Developers
44+
45+
## Build on Windows
46+
47+
The library can be built on Windows using the following command - which assumes that you are in a conda environment that has the conda-forge `pdal` package loaded:
48+
49+
```
50+
cd CAPI
51+
make.bat
52+
```
53+
54+
## Build on Linux and Mac
55+
56+
The library can be built on Linux and Mac using the following command - which assumes that you are in a conda environment that has the conda-forge `pdal` package loaded:
57+
58+
```
59+
cd CAPI
60+
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DCONDA_BUILD=OFF .
61+
make
62+
make install
63+
```
64+
65+
## Code Style
66+
67+
This project enforces the PDAL code styles, which can checked as follows :
68+
69+
- On Windows - as per `astylerc`
70+
- On Linux by running `./check_all.bash`

‎Testing/Temporary/CTestCostData.txt‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎Testing/Temporary/LastTest.log‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)