Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/jon-gilbert/openscad_pvc in…
Browse files Browse the repository at this point in the history
…to main
  • Loading branch information
jon-gilbert committed Aug 14, 2023
2 parents b32dd6b + bdebee6 commit 867d43b
Showing 1 changed file with 3 additions and 36 deletions.
39 changes: 3 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,7 @@ Modules and functions to create PVC pipe models within OpenSCAD

Models have their dimensions and sizes pulled from existing specifications, organized by PVC schedule and size, so they should be sized the same as parts found in a hardware store. PVC parts modeled here come with simple BOSL2 attachable endpoints, so joining parts together relatively easy when constructing pipe layouts or new component parts.

# Usage

Models start by selecting a PVC specification. A range of public PVC specifications are inline to the library: they define diameters and thicknesses and thread sizing for existing piping.

Once a specification is selected, it can be reused over and over to create individual PVC parts.

Individual PVC parts can be quickly modeled and attached to each other using BOSL2's Attachment feature.

A simple example:

```
```openscad
pvc = pvc_spec_lookup(schedule=40, dn="DN20");
pvc_flange(pvc)
attach("B", "A")
Expand All @@ -27,36 +17,13 @@ pvc_flange(pvc)
```
...would yield something that looks like:

![](docs/images/openscad_pvc/section-pvc-component-part-modules_fig1.png)

There's other examples in [the examples directory](examples/), and a full overview on selecting PVC specifications by schedule, and on joining individual PVC parts, can be found in [the docs](docs/openscad_pvc.scad.md).
![](https://github.com/jon-gilbert/openscad_pvc/blob/main/docs/images/openscad_pvc/section-pvc-component-part-modules_fig1.png)

# Installation

Installing this library should be as simple as downloading the .scad file and copying it to your OpenSCAD library directory:
```
wget -N -q -O openscad_pvc.scad https://raw.githubusercontent.com/jon-gilbert/openscad_pvc/main/openscad_pvc.scad
```
The library directory will vary based on your OS; see https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Libraries#Library_locations for the correct location for you.

## Required OpenSCAD Version
Building and using the `openscad_pvc` library requires OpenSCAD 2021.01 or later. Visit https://openscad.org/ for installation instructions.

## Requried External Libraries

### BOSL2
Belfry OpenSCAD Library (v.2). Authored by a number of contributors. Located at https://github.com/revarbat/BOSL2

To download this library, follow the instructions provided at https://github.com/revarbat/BOSL2#installation

### openscad_objects: object_common_functions.scad
Objectifed OpenSCAD library. Authored by Jonathan Gilbert. Located at https://github.com/jon_gilbert/openscd_objects

To download this library,
```
wget -N -q -O object_common_functions.scad https://raw.githubusercontent.com/jon-gilbert/openscad_objects/main/object_common_functions.scad
```
...and copy it to OpenSCAD's library directory.

Additional information on external libraries needed can be found at [the Installation wiki](https://github.com/jon-gilbert/openscad_pvc/wiki/Installation).


0 comments on commit 867d43b

Please sign in to comment.