suzanne.soy/Lattice2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README: tweaks

Browse Source 
* Renamed file to uppercase version
* tweaked header names and size  
* added markdown formatting (2 whitespaces at the end of line to generate a newline)   
* Editing instruction for clarity  
* Re-arranged sections
This commit is contained in:
luz.paz 2019-09-20 20:14:06 -04:00 committed by DeepSOIC
parent 1ce974c5df
commit 2690496fbe
1 changed files with 53 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
readme.md → README.md
View File

@ -1,94 +1,97 @@
# What is Lattice2 workbench
Lattice Workbench is a plug-in module (workbench) for FreeCAD.
# Lattice2 Workbench
Lattice Workbench is a plug-in module/addon (workbench) for FreeCAD.
The workbench purpose is working with placements and arrays of placements. It is a sort of assembly workbench, but with emphasis on arrays. There are no constraints and relations, there are just arrays of placements that can be generated, combined, transformed, superimposed and populated with shapes.
It's purpose is working with placements and arrays of placements. It functions similar to what an Assembly workbench does, but with emphasis on arrays. There are **no** constraints and relations, there are just arrays of placements that can be generated, combined, transformed, superimposed, and populated with shapes.
Ever wondered how to create a protractor with FreeCAD? That's the aim of the workbench (including tick labeling). Also, exploded assemblies can be made with the workbench.
Ever wondered how to create a protractor with FreeCAD? That's the aim of this workbench (including tick labeling). Also, exploded assemblies can be made with this workbench.
Additionally, the workbench features a few general-purpose tools, such as parametric downgrade, bounding boxes, shape info tool, and tools for working with collections of shapes (compounds).
One of the big design goals of the workbench is being as parametric as possible.
# Getting started
## Getting started
Follow through [Basic Tutorial](https://github.com/DeepSOIC/Lattice2/wiki/Basic-Tutorial) to get the basic concept of Lattice2.
Follow through the [Basic Tutorial](https://github.com/DeepSOIC/Lattice2/wiki/Basic-Tutorial) to get the basic concept of Lattice2.
# Highlights
## Highlights
![Lattice2-FreeCAD-wormcutter](https://raw.githubusercontent.com/wiki/DeepSOIC/Lattice2/gallery/worm-cutter-done.png)
![Lattice2-FreeCAD-placement-interpolator](https://raw.githubusercontent.com/wiki/DeepSOIC/Lattice2/gallery/placement_interpolator_fixed.png)
Take a look at other examples in the [Gallery of screenshots](https://github.com/DeepSOIC/Lattice2/wiki/Gallery).
## Features
Let's have a glance over the most important capabilities that the workbench adds to FreeCAD:
* Re-use arrays as many times as you need. Unlike Draft array, which directly generates the array of shapes, lattice array tools generate arrays of placements. These can later be populated with shapes, as many times as necessary, without having to set up another array.
* Re-use arrays as many times as you need. Unlike Draft array, which directly generates the array of shapes, lattice array tools generate arrays of placements. These can later be populated with shapes, as many times as necessary, without having to set up another array.
* Extends PartDesign workflow, offering a way to reuse a sequence of features in arbitrary bodies and places.
* Elements of array can be different. Unlike Draft Arrays, which always generate a set of equal shapes, Lattice arrays can be used to arrange a set of different shapes. Pack the shapes to be arranged into a Compound, and use Lattice [Populate with children](https://github.com/DeepSOIC/Lattice2/wiki/Feature-PopulateChildren) feature to arrange them.
* Arrays of placements can be combined, inverted, generated from existing shape arrangements, made from individual placements, projected onto shapes, filtered, etc. This allows to produce complex arrangements without scripting.
* Single placements can be used for primitive assembling of parts.
* linear arrays and polar arrays can have their axes linked to edges of shapes
* [ParaSeries](https://github.com/DeepSOIC/Lattice2/wiki/Feature-ParaSeries) feature allows to generate a series of parts with some parameter varied over a list of values.
* Extends PartDesign workflow, offering a way to reuse a sequence of features in arbitrary bodies and places.
* Elements of array can be different. Unlike Draft Arrays, which always generate a set of equal shapes, Lattice arrays can be used to arrange a set of different shapes. Pack the shapes to be arranged into a Compound, and use Lattice [Populate with children](https://github.com/DeepSOIC/Lattice2/wiki/Feature-PopulateChildren) feature to arrange them.
* Arrays of placements can be combined, inverted, generated from existing shape arrangements, made from individual placements, projected onto shapes, filtered, etc. This allows to produce complex arrangements without scripting.
* single placements can be used for primitive assembling of parts.
* linear arrays and polar arrays can have their axes linked to edges of shapes
* [ParaSeries](https://github.com/DeepSOIC/Lattice2/wiki/Feature-ParaSeries) feature allows to generate a series of parts with some parameter varied over a list of values.
# Why Lattice2, not just Lattice?
## Why Lattice2, not just Lattice?
Lattice2 was created at the moment when breaking changes needed to be made to Lattice, but there were a few things made with Lattice. So, it was decided to keep the workbench in that time's state indefinitely as version 1.0, and start development of a new version.
The goal was to allow editing old projects made with Lattice v1, by having both versions installed at the same time. So a new repository was started, and all the files were renamed to start with 'lattice2' or otherwise differ from those of Lattice v1.
Lattice3 (if ever) will be a standalone repository, for the same reasons.
# Download/install
repository: https://github.com/DeepSOIC/Lattice2
## Installation
Lattice2 WB requires FreeCAD no less than v0.16.5155. PartDesign tools require v0.17+. Both Py2/Qt4 and Py3/Qt5 builds are supported.
### Prerequisites
The workbench is OS independent, it should work on any system FreeCAD can be run on. If you find that it doesn't - that is a bug. Please make an issue.
* FreeCAD >= `v0.16.5155`
* PartDesign tools require `v0.17+`
* Both Py2/Qt4 and Py3/Qt5 builds are supported.
Lattice2 is written in FreeCAD's Python, and must be run from within FreeCAD. It requires no compilation, and can be installed by copying the repository to a special location.
The workbench is OS independent, it should work on any system FreeCAD can be run on. If you find that it doesn't - that is a bug. Please open an ticket in the [issue queue](https://github.com/DeepSOIC/Lattice2/issues).
# Automated installation:
* The recommended way of installing the workbench is to use FreeCAD's built-in addon manager (Tools->Addon manager).
* Lattice2 workbench is packaged to Launchpad in the Ubuntu FreeCAD Community PPA (thanks to @abdullahtahiriyo).
* Lattice2 can be installed via @microelly's [Plugin Loader](https://github.com/microelly2/freecad-pluginloader)
**Note:** Lattice2 is written in FreeCAD's Python, and **must be run from within FreeCAD**. It requires no compilation, and can be installed by copying the repository to a special location.
# Manual install:
1. Scroll to the top of the page, and click 'clone or download' -> 'download zip' button.
### Automated install
2. Unpack the contents into a "Lattice2" folder created in \Path\to\FreeCAD\Mod, and restart FreeCAD. <br>
Note that InitGui.py (and the rest of .py files) should end up directly under Mod\Lattice2 (not under nested directory like Mod\Lattice2\Lattice2).
There are several options to automate installation of this workbench.
* The **most recommended method** is to use FreeCAD's built-in [Addon Manager](https://github.com/FreeCAD/FreeCAD-addons#1-builtin-addon-manager) (Tools > Addon manager).
* Another method; Lattice2 workbench is packaged to Launchpad in the Ubuntu FreeCAD Community PPA (thanks to @abdullahtahiriyo).
* Lattice2 can be installed via @microelly's [Plugin Loader](https://github.com/microelly2/freecad-pluginloader) (this option is deprecated).
On windows:<br>
`%AppData%\FreeCAD\Mod`, for all installs of FreeCAD<br>
`C:\Program Files\FreeCAD\Mod` (typ), for individual install of FreeCAD<br>
On Linux:<br>
`/home/userxyz/.FreeCAD/Mod/`<br>
MacOS:<br>
???
**Note:** Any of the above options will require a restart of FreeCAD in order for the workbench to function.
After you install the workbench, it should appear at the bottom of list of workbench selector in FreeCAD.
### Manual install
1. Scroll to the top of the page, and click 'clone or download' -> 'download zip' button or you can run: `wget https://github.com/DeepSOIC/Lattice2
2. Unpack the contents into a "Lattice2" subfolder within your default FreeCAD install directory.
* Windows: (sytem-wide install) `%AppData%\FreeCAD\Mod\Lattice2`
* Windows: (for individual installs)
`C:\Program Files\FreeCAD\Mod\Lattice2`
* Linux: `~/.FreeCAD/Mod/Lattice2`
* MacOS: `~/.FreeCAD/Mod/Lattice2`
3. Restart FreeCAD
If you want to install the workbench for development, git clone the repository wherever you like, and make a symlink in where FreeCAD can pick up add-ons
**Important Note:** Make sure that `InitGui.py` (and the rest of `.py` files) end up directly under `Mod\Lattice2` directory (not under nested directory like `Mod\Lattice2\Lattice2`).
# License
Lattice workbench is licenced under LGPL V2, just like FreeCAD. For more info, see copying.lib file in the repository.
Usage:
After installing the workbench and restarting FC, Lattice2 should now appear in the workbench dropdown menu. It will be listed down towards the bottom of list. You can learn Lattice2 through the [Basic Tutorial](https://github.com/DeepSOIC/Lattice2/wiki/Basic-Tutorial) now.
Side Note: If you want to install the workbench for development, `git clone` the repository wherever you like, and make a symlink in where FreeCAD can pick it up as an add-on.
# Status
The workbench is stable. I will take care to not make breaking changes, and some new functionality may keep coming.
If you make your FreeCAD project using Lattice2, all further changes to the project must be done with Lattice2 installed, even if you don't touch the relevant features. Otherwise, the parametric features in the project will lose their bound functionality, and will not recompute, even if you install Lattice2 later. This is the case for all add-ons in FreeCAD, not just Lattice2.
# Getting Help
Documentation: see [Lattice2 wiki](https://github.com/DeepSOIC/Lattice2/wiki) on Github. As the word "wiki" suggests, you can help by editing the documentation.
If you need help on something specific, you can ask a question on [FreeCAD forum](http://forum.freecadweb.org/index.php) (there is no Lattice forum yet...). You can also ask me directly. If you post to the forum, please add this to your post so that I get a notification: `[quote=DeepSOIC user_id=3888]Ding![/quote]`
If you need help on something specific, you can ask a question on [FreeCAD forum](http://forum.freecadweb.org/) (there is no Lattice forum yet...). You can also ask me directly. If you post to the forum, please add this to your post so that I get a notification: `[quote=DeepSOIC user_id=3888]Ding![/quote]`
If you have found a bug, report it [here, in Github's issue tracker for Lattice2](https://github.com/DeepSOIC/Lattice2/issues). You can also post ideas for new features there, as well as plain questions.
If you have fixed a bug, or implemented a new feature you think suits the workbench, or whatever - feel free to make a pull-request here on github.
If you have fixed a bug, or implemented a new feature you think suits the workbench, or whatever - feel free to make a pull-request here on Github.
# Status
The workbench is stable. I will take care to not make breaking changes, and some new functionality may keep coming.
# License
If you make your FreeCAD project using Lattice2, all further changes to the project must be done with Lattice2 installed, even if you don't touch the relevant features. Otherwise, the parametric features in the project will lose their bound functionality, and will not recompute, even if you install Lattice2 later. This is the case for all add-ons in FreeCAD, not just Lattice2.
Lattice workbench is licensed under LGPL V2, just like FreeCAD. For more info, see [copying.lib](copying.lib) file in this repository.