Giter Club home page Giter Club logo

compas_slicer's Introduction

compas_slicer

build GitHub - License PyPI - Latest Release DOI

Slicing package for FDM 3D Printing with COMPAS.

Main features

  • Planar slicing (default method, and method based on Cgal library)
  • Curved slicing (interpolation of boundaries, UV slicing, scalar field slicing)
  • Generation of fabrication-related information
  • Export print data to Json and gcode formats

Getting started

Step 1: Installation

The recommended way to install compas_slicer is with conda. For example, create an environment named my-project (or replace with your own environment name) and install as follows:

conda config --add channels conda-forge
conda create -n my-project compas_slicer

Step 2: Optional installation steps

COMPAS Viewers

Follow the instructions to install compas_view2 (https://github.com/compas-dev/compas_view2).

COMPAS CGAL

conda install -n my-project compas_cgal

Grasshopper

The Grasshopper components are automatically installed with the compas_rhino installation, e.g.:

conda activate my-project
python -m compas_rhino.install -v 6.0

Step 3. Test if the library works

Activate your environment and run the following command:

conda activate my-project
python -m compas_slicer

Enjoy!

Troubleshooting

See here: https://compas.dev/compas_slicer/installation.html#troubleshooting-1

Contributions

Before contributing code:

  • Install development dependencies:
pip install -r requirements-dev.txt
  • Make sure all tests pass:
invoke test
  • Make sure you pass flake8 tests. (hint: This is the most annoying part of the process)
invoke lint
  • Add an example on the examples folder that uses the new functionality. Run the example and make sure it works smoothly.

  • Create a pull request for the master branch, where you explain in detail what you fixed. When you create a pull request, there is an automatic action that runs the tests for your code again on the server. Make sure the pull request passes the automatic tests as well. If not, then inspect the result, find what went wrong, fix it, and push again the result on your branch. The action will run again automatically on the open pull request.

Authors

compas_slicer's People

Contributors

ioannamitropoulou avatar joburger avatar gonzalocasas avatar stratocaster avatar worbit avatar tomvanmele avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.