https://github.com/compas-dev/compas_robots

Basic infrastructure for working with robots in COMPAS.

https://github.com/compas-dev/compas_robots

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.4%) to scientific vocabulary

Keywords

aec kinematics python robotics robots
Last synced: 5 months ago · JSON representation

Repository

Basic infrastructure for working with robots in COMPAS.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 8
  • Forks: 6
  • Open Issues: 7
  • Releases: 7
Topics
aec kinematics python robotics robots
Created over 2 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Authors

README.md

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
    

Owner

  • Name: compas-dev
  • Login: compas-dev
  • Kind: organization

COMPAS - an open source computational framework for research and collaboration in AEC

GitHub Events

Total
  • Issues event: 3
  • Issue comment event: 8
  • Push event: 9
  • Pull request review comment event: 21
  • Pull request review event: 25
  • Pull request event: 3
  • Fork event: 1
  • Create event: 2
Last Year
  • Issues event: 3
  • Issue comment event: 8
  • Push event: 9
  • Pull request review comment event: 21
  • Pull request review event: 25
  • Pull request event: 3
  • Fork event: 1
  • Create event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 9
  • Total pull requests: 21
  • Average time to close issues: 2 months
  • Average time to close pull requests: 18 days
  • Total issue authors: 5
  • Total pull request authors: 8
  • Average comments per issue: 1.22
  • Average comments per pull request: 1.33
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 10
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 days
  • Issue authors: 2
  • Pull request authors: 5
  • Average comments per issue: 0.67
  • Average comments per pull request: 1.0
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • gonzalocasas (3)
  • djy89 (2)
  • yck011522 (1)
  • ZacZhangzhuo (1)
  • chenkasirer (1)
Pull Request Authors
  • yck011522 (18)
  • chenkasirer (6)
  • PingHsunTsai (4)
  • gonzalocasas (4)
  • tomvanmele (2)
  • gidodielemans (2)
  • ZacZhangzhuo (2)
  • Licini (1)
Top Labels
Issue Labels
Pull Request Labels
no changelog (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 620 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 7
  • Total maintainers: 1
pypi.org: compas-robots

Basic infrastructure for working with robots in COMPAS.

  • Versions: 7
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 620 Last month
Rankings
Dependent packages count: 9.9%
Forks count: 24.5%
Average: 35.4%
Stargazers count: 41.6%
Dependent repos count: 65.4%
Maintainers (1)
Last synced: 6 months ago