Skip to main content

Basic infrastructure for working with robots in COMPAS.

Project description

COMPAS Robots

Basic infrastructure for working with robots in COMPAS.

Getting started with this project

Setup code editor

  1. Open project folder in VS Code
  2. Select python environment for the project
  3. First time using VS Code and on Windows? Make sure select the correct terminal profile: Ctrl+Shift+P, Terminal: Select Default Profile and select Command Prompt.

All terminal commands in the following sections can be run from the VS Code integrated terminal.

First steps with git

  1. Go to the Source control tab
  2. Make an initial commit with all newly created files

First steps with code

  1. Install the newly created project

     pip install -e .
    
  2. Install it on Rhino

     python -m compas_rhino.install
    

Code conventions

Code convention follows PEP8 style guidelines and line length of 120 characters.

  1. Check adherence to style guidelines

     invoke lint
    
  2. Format code automatically

     invoke format
    

Documentation

Documentation is generated automatically out of docstrings and RST files in this repository

  1. Generate the docs

     invoke docs
    
  2. Check links in docs are valid

     invoke linkcheck
    
  3. Open docs in your browser (file explorer -> dist/docs/index.html)

Testing

Tests are written using the pytest framework

  1. Run all tests from terminal

     invoke test
    
  2. Or run them from VS Code from the Testing tab

Publish release

Releases follow the semver versioning convention.

  1. Create a new release

     invoke release major
    

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_robots-0.6.0.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

compas_robots-0.6.0-py2.py3-none-any.whl (2.7 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file compas_robots-0.6.0.tar.gz.

File metadata

  • Download URL: compas_robots-0.6.0.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for compas_robots-0.6.0.tar.gz
Algorithm Hash digest
SHA256 84daf63eeea664dc9de5beb5cf944680444ef7c5a8f5605eab5910d735b538fc
MD5 4343d5213db0a25320484eb2dd23917c
BLAKE2b-256 c6d7dac550d037f939ecff1aecbe2787a607efe7c47ebe8f8d453559d1132baa

See more details on using hashes here.

File details

Details for the file compas_robots-0.6.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for compas_robots-0.6.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f958c26f03661fc058fc126e5977db96814a2c648e9075d23d832dbc7e9fc561
MD5 ec4f07ef27a1c5024098fc31b090f9b5
BLAKE2b-256 4321e71af9bdc965c6a3605ace81cb6fbb0a9aeb56932996c845b33855bb1000

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