pye57 0.4.3__tar.gz → 0.4.4__tar.gz

{pye57-0.4.3/src/pye57.egg-info → pye57-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pye57
-Version: 0.4.3
+Version: 0.4.4
 Summary: Python .e57 files reader/writer
 Home-page: https://www.github.com/davidcaron/pye57
 Author: David Caron

pye57-0.4.4/libE57Format/LICENSE-MIT.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andy Maloney (asmaloney@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pye57-0.4.4/libE57Format/README.md

@@ -0,0 +1,162 @@
+# libE57Format
+
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/asmaloney/libE57Format)](https://github.com/asmaloney/libE57Format/releases/latest) [![Docs](https://img.shields.io/badge/docs-online-orange)](https://asmaloney.github.io/libE57Format-docs/) [![GitHub](https://img.shields.io/github/license/asmaloney/libE57Format)](LICENSE) ![Build](https://github.com/asmaloney/libE57Format/actions/workflows/build.yml/badge.svg)
+
+libE57Format is a C++ library which provides read & write support for the ASTM-standard [E57 file format](https://www.astm.org/e2807-11r19e01.html) on Linux, macOS, and Windows. E57 files store 3D point cloud data (produced by 3D imaging systems such as laser scanners), attributes associated with 3D point data (color & intensity), and 2D images (photos taken using a 3D imaging system).
+
+## Documentation
+
+The doxygen-generated documentation may be [found here](https://asmaloney.github.io/libE57Format-docs/). These docs are generated and saved in the [libE57Format-docs](https://github.com/asmaloney/libE57Format-docs) repo.
+
+## Dependencies/Requirements
+
+Tools:
+
+- a [C++14](https://en.cppreference.com/w/cpp/14) compatible compiler
+- [CMake](https://cmake.org/) >= 3.15
+- [clang-format](https://clang.llvm.org/docs/ClangFormat.html) for code formatting
+- (_optional_) [ccache](https://ccache.dev/) to speed up rebuilds
+
+Libraries:
+
+- [Xerces-C++](https://xerces.apache.org/xerces-c/) (for parsing XML)
+
+### Installing Dependencies On Linux (Ubuntu)
+
+```sh
+$ sudo apt install libxerces-c-dev clang-format
+```
+
+### Installing Dependencies On macOS (homebrew)
+
+```sh
+$ brew install ccache clang-format xerces-c
+```
+
+## Build, Install, & Test
+
+Here's how you build & install a release version with the defaults:
+
+```
+$ cmake -B E57-build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=E57-install libE57Format
+$ cmake --build E57-build --parallel
+$ cmake --install E57-build
+```
+
+If CMake can't find the xerces-c library, you can set [CMAKE_PREFIX_PATH](https://cmake.org/cmake/help/latest/variable/CMAKE_PREFIX_PATH.html) to point at it.
+
+```
+$ cmake -B E57-build \
+    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_INSTALL_PREFIX=E57-install \
+    -DCMAKE_PREFIX_PATH=/path/to/xerces-c \
+    libE57Format
+```
+
+Once the library is built, you can run the tests like this:
+
+```
+$ cd E57-build
+$ ./test/testE57
+[==========] Running 36 tests from 8 test suites.
+[----------] Global test environment set-up.
+[----------] 1 test from TestData
+[ RUN      ] TestData.RepoExists
+...
+```
+
+See [test/README](test/README.md) for details about testing and the test data.
+
+## 🍴 Fork
+
+This is a fork of [E57RefImpl](https://sourceforge.net/projects/e57-3d-imgfmt/). The original source is from [E57RefImpl 1.1.332](https://sourceforge.net/projects/e57-3d-imgfmt/files/E57Refimpl-src/).
+
+The original code had not been touched in years and I wanted to make changes to compile it on macOS. Forking it gave me a bit more freedom to update the code and make changes as required. Everything was stripped out except the main implementation for reading & writing E57 files.
+
+Notes:
+
+- I changed the name of the project so that it is not confused with the **E57RefImpl** project.
+- I changed the main include file's name from `E57Foundation.h` to `E57Format.h` to make sure there is no inclusion confusion.
+- Versions of **libE57Format** started at 2.0.
+- I made changes for it to compile and run on macOS.
+- It no longer depends on [Boost](http://www.boost.org/).
+- It now requires [C++14](https://en.cppreference.com/w/cpp/14). (Version 2.x required [C++11](https://en.cppreference.com/w/cpp/11).)
+
+Many, many other changes were made prior to the first release of this fork. See the [CHANGELOG](CHANGELOG.md) and git history for details.
+
+### E57Simple API
+
+[Jiri Hörner](https://github.com/ptc-jhoerner) added the E57Simple API from the old reference implementation and updated it.
+
+This _Simple API_ has evolved since this original port to fix some problems and to make it more foolproof & easier to use. Please see the [CHANGELOG](CHANGELOG.md) for version 3.
+
+### Tools
+
+[Ryan Baumann](https://github.com/ryanfb) updated the `e57unpack` and `e57validate` tools to work with **libE57Format**. You can find them in the [e57tools](https://github.com/ryanfb/e57tools) repo.
+
+## Projects Using libE57Format
+
+- [CloudCompare](https://github.com/CloudCompare/CloudCompare)
+- [MeshLab](https://github.com/cnr-isti-vclab/meshlab)
+- [pye57](https://github.com/davidcaron/pye57)
+
+These projects use hard forks of libE57Format:
+
+- [FreeCAD](https://github.com/FreeCAD/FreeCAD)
+- [PDAL](https://github.com/PDAL/PDAL)
+
+There are also some commercial products using libE57Format. If any of them would like to sponsor the project and be listed here, please contact Andy (asmaloney).
+
+## How To Contribute
+
+These are some of the things you can do to contribute to the project:
+
+### ✍ Write About The Project
+
+If you find the project useful, spread the word! Articles, mastodon posts, tweets, blog posts, instagram photos - whatever you're into.
+
+### ⭐️ Add a Star
+
+If you found this project useful, please consider starring it! It helps me gauge how useful this project is.
+
+### ☝ Raise Issues
+
+If you run into something which doesn't work as expected, raising [an issue](https://github.com/asmaloney/libE57Format/issues) with all the relevant information to reproduce it would be helpful.
+
+### 🐞 Bug Fixes & 🧪 New Things
+
+I am happy to review any [pull requests](https://github.com/asmaloney/libE57Format/pulls). Please keep them as short as possible. Each pull request should be atomic and only address one issue. This helps with the review process.
+
+Note that I will not accept everything, but I welcome discussion. If you are proposing a big change, please raise it as [an issue](https://github.com/asmaloney/libE57Format/issues) first for discussion.
+
+#### Formatting
+
+This project uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to format the code. There is a cmake target (_e57-clang-format_) - which runs _clang-format_ on the source files. After changes have been made, and before you submit your pull request, please run the following:
+
+```sh
+cmake --build . --target e57-clang-format
+```
+
+### 📖 Documentation
+
+The [documentation](https://github.com/asmaloney/libE57Format) is a bit old and could use some lovin'. You can submit changes over in the [libE57Format-docs](https://github.com/asmaloney/libE57Format-docs) repository.
+
+### 💰 Financial
+
+Given that I'm an independent developer without funding, financial support is always appreciated. If you would like to support the project financially (especially if you sell a product which uses this library), you can use the [sponsors page](https://github.com/sponsors/asmaloney) for one-off or recurring support. Thank you!
+
+## License
+
+This project as a whole is licensed under the [**BSL-1.0** license](https://opensource.org/licenses/BSL-1.0) - see the [LICENSE](LICENSE.md) file for details.
+
+Individual source files may contain the following tag instead of the full license text:
+
+    SPDX-License-Identifier: BSL-1.0
+
+Most of the CMake files, all of the testing files, and a couple of the source files are licensed under the [**MIT** license](https://opensource.org/license/mit/) - see the [LICENSE-MIT](LICENSE-MIT.md) file for details.
+
+These files contain the following tag instead of the full license text:
+
+    SPDX-License-Identifier: MIT
+
+Using SPDX enables machine processing of license information based on the [SPDX License Identifiers](https://spdx.org/ids) and makes it easier for developers to see at a glance which license they are dealing with.

{pye57-0.4.3 → pye57-0.4.4}/libE57Format/extern/CRCpp/LICENSE

@@ -1,5 +1,5 @@
 CRC++
-Copyright (c) 2016, Daniel Bahr
+Copyright (c) 2022, Daniel Bahr
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

{pye57-0.4.3 → pye57-0.4.4}/libE57Format/extern/CRCpp/README.md

@@ -82,7 +82,24 @@ int main(int argc, char ** argv)
 
 This will return the same CRC as the first example.
 
-Both of the above examples compute a CRC bit-by-bit. However, CRC++ also supports lookup tables, as the following example demonstrates:
+If you need to compute a CRC on an input that is not a multiple of `CHAR_BIT` (usually 8 bits), use the `CalculateBits()` function instead:
+
+```cpp
+int main(int argc, char ** argv)
+{
+	const unsigned char data[] = { 0x98, 0x76, 0x54, 0x32, 0x10 };
+	
+	// Second argument is the number of bits. The input data must
+	// be a whole number of bytes. Pad any used bits with zeros.
+	std::uint32_t crc = CRC::CalculateBits(data, 37, CRC::CRC_32());
+	
+	std::cout << std::hex << crc;
+	
+	return 0;
+}
+```
+
+The above examples compute a CRC bit-by-bit. However, CRC++ also supports lookup tables, as the following example demonstrates:
 
 ```cpp
 int main(int argc, char ** argv)
@@ -149,6 +166,56 @@ Define to enables C++11 features (move semantics, constexpr, static_assert, etc.
 * `#define CRCPP_INCLUDE_ESOTERIC_CRC_DEFINITIONS`
 Define to include definitions for little-used CRCs. Not defined by default.
 
+### Build
+
+CRC does not require a build for basic usage; simply include the header file in your project.
+
+Unit tests and documentation can be built manually with the project files provided or automatically with CMake.
+
+To build documentation manually:
+```bash
+cd doxygen
+doxygen Doxyfile.dox
+```
+
+To build unit tests manually via Make:
+```bash
+# Build
+cd test/prj/gcc
+make [debug|release]
+# Run unit tests
+bin/unittest
+```
+
+Project files and solutions for Visual Studio 2015, 2017 and 2022 are provided in `test/prj`. Simply open the solution file and run the project; no additional configuration should be necessary.
+
+CMake can also be used to build the documentation and unit tests. An out-of-source build is recommended. In this example, we will do an out-of-source build in the `build` directory:
+```bash
+mkdir -p build
+cd build
+cmake .. [-DBUILD_DOC=ON]
+# Build and run unit tests
+make tests
+# Build documentation
+make doxygen
+# Install header file
+sudo make install
+```
+
+Unit tests are built by default. Enable the `BUILD_DOC` CMake flag to also build documentation (requires [Doxygen](https://www.doxygen.nl/index.html)).
+
+### Documentation
+
+https://d-bahr.github.io/CRCpp/
+
 ### License
 
 CRC++ is free to use and provided under a BSD license.
+
+### References
+
+Catalog of CRCs: https://reveng.sourceforge.io/crc-catalogue/
+
+5G-NR Specification 3GPP TS 38.212: https://www.etsi.org/deliver/etsi_ts/138200_138299/138212/15.03.00_60/ts_138212v150300p.pdf
+
+USB 2.0 Specification: https://www.usb.org/document-library/usb-20-specification