/SPKL-BG-SpecklePY-LIB

Python library aimed at extending the functionality of specklepy.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

bg_specklepy

Bollinger+Grohmann Library with specklepy.

📚 Description

Python library aimed at extending the functionality of specklepy.

🖇 Dependencies

Required dependencies are automatically checked. Should a library not be available for a specific class / method, the user will be prompted to install with a simple "y" input on the console.

  • specklepy
  • Pandas
  • NumPy
  • specklepytrimesh

⚖ License

License: GPL v3, details here

🙌 Special Thanks To

A special word of appreciation goes out to the Speckle Team. Continuous support throughout development, for example, in the Community platform by @jsdbroughton made a profound impact on development.

💭 Examples

01 - Column Eccentricity Example

🚀 Contributions

Any and all contributions are welcome! Kindly follow the below guidelines:

  1. Clone the repository
    • This will create a copy of the project on your computer that you can modify and test
  2. Create a new branch before you start making changes
    • Naming convention: yourUsername-FeatureAddedOrChange
    • This will allow you to work on a separate copy of the project without affecting the original code
  3. Make changes / developments / advancements
    • Test your changes before submitting them, ideally with a unit test / example script
  4. Commit your changes once you are done
  5. Push changes to GitHub
  6. Create a pull request
    • Pull request should include a description of the changes you made and why they are important
  7. Respond to feedback from reviewer(s)

🤝 Collaborations

Keen to collaborate? So are we! Feel free to reach out under the Discussions Tab or on LinkedIn.