Skip to main content

NURBS for COMPAS

Project description

This package is inspired by the NURBS-Python package, however uses a NumPy-based backend for better performance.

Curve, and Surface are non-uniform non-rational B-Spline geometries (NUBS), RationalCurve, and RationalSurface are non-uniform rational B-Spline Geometries (NURBS). They all built upon the class BSpline. Coordinates have to be in 3D space (x, y, z).

Please refer to the Documentation for details.

COMPAS NURBS runs on Python x.x and x.x.

Getting Started

The recommended way to install COMPAS NURBS is to use a Anaconda/conda environment:

conda config --add channels conda-forge
conda create -n ENV_NAME compas
conda activate ENV_NAME
pip install compas_nurbs

Once the installation is completed, you can verify your setup. Start Python from the command prompt and run the following:

>>> import compas_nurbs

You are ready to use COMPAS NURBS!

Contributing

Make sure you setup your local development environment correctly:

  • Clone the compas_nurbs repository.

  • Install development dependencies and make the project accessible from Rhino:

pip install -r requirements-dev.txt
python -m compas_rhino.install

You’re ready to start working!

During development, use tasks on the command line to ease recurring operations:

  • invoke clean: Clean all generated artifacts.

  • invoke check: Run various code and documentation style checks.

  • invoke docs: Generate documentation.

  • invoke test: Run all tests and checks in one swift command.

  • invoke: Show available tasks.

For more details, check the Contributor’s Guide.

Releasing this project

Ready to release a new version of COMPAS NURBS? Here’s how to do it:

  • We use semver, i.e. we bump versions as follows:

    • patch: bugfixes.

    • minor: backwards-compatible features added.

    • major: backwards-incompatible changes.

  • Update the CHANGELOG.rst with all novelty!

  • Ready? Release everything in one command:

invoke release [patch|minor|major]
  • Celebrate! 💃

Credits

This package was created by Romana Rust <rust@arch.ethz.ch> @romanarust at @gramaziokohler

Changelog

0.2.0

Added

  • Added SurfaceArtist for GhPython

  • Added CurveArtist for GhPython

Changed

Fixed

Deprecated

Removed

0.1.0

  • Initial version

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

compas_nurbs-0.2.0.tar.gz (546.1 kB view details)

Uploaded Source

Built Distribution

compas_nurbs-0.2.0-py2.py3-none-any.whl (32.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file compas_nurbs-0.2.0.tar.gz.

File metadata

  • Download URL: compas_nurbs-0.2.0.tar.gz
  • Upload date:
  • Size: 546.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for compas_nurbs-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c2da7afa48cb165a70a507d27ea11f71645cc3da5811c1f5c79332ee626794bc
MD5 4c32c973705fd88b920711fcd0f68439
BLAKE2b-256 88183988642fbb39db5c1a2d7b4648f8851a0b5c599b1f594058c1c6794fe8a4

See more details on using hashes here.

File details

Details for the file compas_nurbs-0.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: compas_nurbs-0.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 32.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for compas_nurbs-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f7fc0fbca5349c306cc1145be7a4773ec252c8607cfb671514f4dd0e07230745
MD5 196ef10184bdbf51f03bfcb901a433ea
BLAKE2b-256 7c2ea33d641c7cd5b9c3c473b45829b7f3d2823fcabba76a4141ea7973df8bb3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page