Skip to content

Commit 25d7d66

Browse files
author
ioannam
committed
Small documentation updates
1 parent 1d91a34 commit 25d7d66

File tree

3 files changed

+27
-10
lines changed

3 files changed

+27
-10
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,6 @@
77

88
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.
99

10-
## Main features
11-
12-
* Planar slicing (default method, and method based on Cgal library)
13-
* Curved slicing (interpolation of boundaries, UV slicing, scalar field slicing)
14-
* Generation of fabrication-related information
15-
* Export print data to Json and gcode format
16-
* Visualization of results in grasshopper
17-
1810
## Getting started
1911

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

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

18+
## Main features
19+
20+
* Planar slicing (default method, and method based on Cgal library)
21+
* Curved slicing (interpolation of boundaries, UV slicing, scalar field slicing)
22+
* Generation of fabrication-related information
23+
* Export print data to Json and gcode format
24+
* Visualization of results in grasshopper
25+
2626
## Authors
2727

2828
* Ioanna Mitropoulou <<[email protected]>> [@ioannaMitropoulou](https://github.com/ioannaMitropoulou)

docs/installation.rst

+19
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,25 @@ Activate your environment and run the following command:
5050
conda activate my-project
5151
python -m compas_slicer
5252
53+
54+
* Install from local folder
55+
56+
If you would like to install the latest code from github, or to make modifications on the code and have the updated version
57+
run in your environment, then you can install compas_slicer from a local folder in your computer. To do that, after following
58+
the steps described above clone the compas_slicer repository using the command
59+
60+
.. code-block:: bash
61+
62+
git clone https://github.com/compas-dev/compas_slicer.git
63+
64+
Navigate to the compas_slicer folder and after you activate the desired environment, install compas_slicer from the local copy
65+
with the following command:
66+
67+
.. code-block:: bash
68+
conda activate my-project
69+
pip install -e .
70+
71+
5372
Enjoy!
5473

5574

src/compas_slicer/print_organization/interpolation_print_organizer.py

-2
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,6 @@ def create_base_boundaries(self):
8888
else:
8989
bs.append(root_boundary)
9090

91-
assert(len(bs) == len(self.vertical_layers))
92-
9391
# save intermediary outputs
9492
b_data = {i: b.to_data() for i, b in enumerate(bs)}
9593
utils.save_to_json(b_data, self.OUTPUT_PATH, 'boundaries.json')

0 commit comments

Comments
 (0)