Skip to content

Commit

Permalink
Small documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ioannam committed Mar 11, 2024
1 parent 1d91a34 commit 25d7d66
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 10 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,6 @@

Python slicing package for FDM 3D Printing based on the [COMPAS](https://block.arch.ethz.ch/brg/tools/compas-computational-framework-for-collaboration-and-research-in-architecture-structures-and-digital-fabrication) framework.

## 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 format
* Visualization of results in grasshopper

## Getting started

You can find tutorials and documentation of the project in the [compas_slicer page](https://compas.dev/compas_slicer/latest/)
Expand All @@ -23,6 +15,14 @@ For installation instructions, see here: [installation](https://compas.dev/compa

For troubleshooting, see here: [troubleshooting](https://compas.dev/compas_slicer/installation.html#troubleshooting-1)

## 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 format
* Visualization of results in grasshopper

## Authors

* Ioanna Mitropoulou <<mitropoulou@arch.ethz.ch>> [@ioannaMitropoulou](https://github.com/ioannaMitropoulou)
Expand Down
19 changes: 19 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,25 @@ Activate your environment and run the following command:
conda activate my-project
python -m compas_slicer
* Install from local folder

If you would like to install the latest code from github, or to make modifications on the code and have the updated version
run in your environment, then you can install compas_slicer from a local folder in your computer. To do that, after following
the steps described above clone the compas_slicer repository using the command

.. code-block:: bash
git clone https://github.com/compas-dev/compas_slicer.git
Navigate to the compas_slicer folder and after you activate the desired environment, install compas_slicer from the local copy
with the following command:

.. code-block:: bash
conda activate my-project
pip install -e .
Enjoy!


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,6 @@ def create_base_boundaries(self):
else:
bs.append(root_boundary)

assert(len(bs) == len(self.vertical_layers))

# save intermediary outputs
b_data = {i: b.to_data() for i, b in enumerate(bs)}
utils.save_to_json(b_data, self.OUTPUT_PATH, 'boundaries.json')
Expand Down

0 comments on commit 25d7d66

Please sign in to comment.