Python package

The rhinoartisan package

import rhinoartisan as ra — API 0.9.0, shipped with RhinoArtisan 7.0.0.11 for Rhino 8+ (Python 3). The plugin installs the package into Rhino’s scripts folder, so the import needs no setup in the ScriptEditor, RhinoCode, Flow Studio or MCP.

#! python 3
import rhinoartisan as ra

with ra.transaction("Solitaire 1 ct"):
    ring = ra.classic.create(width=2.5)
    gem = ra.gems.create("round", "diamond", 1.0, (0, 0, ring.ring_diameter_mm / 2 + 1))
    ra.peghead.create(gem, prongs=6)
print(f"{ra.weight.calculate()[0].grams:.2f} g")

Conventions: optional arguments default to None (the tool default); ids are strings and any handle, string or Rhino object id works where an id is expected; points and vectors are (x, y, z) tuples; a plane is a point (normal +Z), an (origin, normal) pair or a Rhino Plane; millimetres everywhere. Handles expose properties — assigning a settable one regenerates the object — plus update(**kwargs), parameters(), id and delete(). See Errors and Results.

Gems

Module
`ra.advanced_gems_on_curve`	Runs of stones along a curve with per-stone sizes, shapes and rotations.
`ra.gems`	Create, query and edit stones: shapes, materials, carats, placement, copies, collisions.
`ra.gem_orientation`	Fix the orientation plane of stones without moving them.
`ra.gem_size`	Stones by millimetre size instead of carats.
`ra.gem_tools`	Utilities over existing stones: centers, tags, alignment, curves from gems, copy by gems, colors by size.
`ra.gems_by_network`	Stones over a network of intersecting curves, sized to meet at the nodes.
`ra.gems_from_circle`	Turn circles into round stones of the matching size.
`ra.gems_on_two_curves`	Stones fitted between two rails, sized to the gap.
`ra.gems_on_curve`	A run of stones along one curve, with prongs and cutters, editable afterwards.
`ra.tapered_baguettes`	Tapered baguettes between two curves.
`ra.three_stones`	The classic three-stone layout.
`ra.toi_et_moi`	Two stones facing each other.
`ra.trilogy`	Three-stone families: trellis, halo, individual, bezel set, east-west.

Settings

Module
`ra.advanced_basket`	Baskets with independent prong and rail profiles.
`ra.advanced_bezel`	Bezels with a custom profile.
`ra.basket`	Basket settings: prongs, upper and base rails.
`ra.bezel`	Bezel settings with support, cutter and air-gap sections.
`ra.cabochon`	Cabochon stones and their settings.
`ra.channel`	Channel settings along a curve.
`ra.cluster`	Cluster settings around a centre stone.
`ra.cutter`	The cutters that carve the seat of a stone into the metal.
`ra.halo`	A halo of small stones around a centre stone.
`ra.hidden_halo`	A hidden halo under the centre stone.
`ra.martini`	Martini settings.
`ra.micro_setting`	Micro settings (micro-pave heads).
`ra.pearl`	Pearls and their cups.
`ra.peghead`	Peghead seats under a stone: prongs, height, thickness.
`ra.trellis_gemset`	Trellis settings.
`ra.tulip`	Tulip settings.

Shanks and rings

Module
`ra.advanced_cathedral`	Cathedral shanks with station-by-station control.
`ra.advanced_pave_shank`	Advanced pave shanks: rows of stones you lay out along the band.
`ra.advanced_ring`	Rings built from positioned sections along the finger curve.
`ra.advanced_signet_ring`	Signet rings with independent top and side profiles.
`ra.bypass`	Bypass shanks whose arms cross past each other.
`ra.cathedral`	Cathedral shanks: arms rising toward the setting.
`ra.class_ring`	Class rings.
`ra.classic`	Classic ring shanks: comfort-fit bands at the document finger size, optionally with a stone row.
`ra.contour_band`	Contour bands fitted against an engagement ring.
`ra.eternity`	Eternity bands with stones all around.
`ra.graduated`	Graduated shanks: a run of stones shrinking away from the centre.
`ra.pave_shank`	Pave shanks: automatic rows of stones across a one-profile band.
`ra.plain_band`	Single plain bands.
`ra.ring_curve`	Ring rail curves at the document finger size (closed, open, bypass, shaped).
`ra.ring_extrude`	Rings extruded from a frontal profile.
`ra.ring_tools`	Utilities on ring geometry: cut by ring size, estimate size, rail helpers.
`ra.scoop_ring`	Scoop rings.
`ra.signet_ring`	Signet rings with a shaped top face.
`ra.split_shank`	Split shanks.
`ra.two_rows_shank`	Two-row shanks.
`ra.wedding`	Wedding sets (band pairs) built as one editable object.

Pave and prongs

Module
`ra.automatic_pave`	Relaxed multi-size pave fill with symmetry.
`ra.azure`	Azure cutters under a pave: the openwork underneath.
`ra.pave_along_surface`	Pave rows following a surface direction.
`ra.pave`	Automatic pave over surfaces: one size in a regular grid, with prongs and cutters.
`ra.prong`	Prongs: dynamic (between stones), automatic, custom and axis-aligned.

Components

Module
`ra.bail`	Pendant bails.
`ra.bangle`	Bangles.
`ra.bead`	Beads.
`ra.chain`	Chains along a curve.
`ra.charm`	Charms.
`ra.engraving`	Ring engravings.
`ra.hinge`	Hinges.
`ra.honeycomb`	Honeycomb patterns over surfaces.
`ra.huggie`	Huggie earrings.
`ra.link`	Chain links.
`ra.milgrain`	Milgrain beading along curves.
`ra.named_pendant`	Name pendants from text.
`ra.pattern`	Repeated patterns over surfaces.
`ra.profile_sweep`	Sweeps of a profile along rails.
`ra.rope`	Rope twists.
`ra.smart_component`	Edit bails, named pendants, bangles, beads, charms, links, milgrain, ropes, 3D textures and ring engravings after creation (their model as JSON).
`ra.text_on_curve`	Text laid along a curve.
`ra.texture_3d`	3D textures applied to surfaces.
`ra.user_element`	User-defined elements.
`ra.voronoi`	Voronoi patterns over surfaces.

Solids, curves and transforms

Module
`ra.boolean`	Artisan booleans that keep the pieces editable: union, difference, intersection, split, update.
`ra.curve`	Curve helpers for jewelry layouts.
`ra.mesh`	Mesh decimation.
`ra.raster_to_vector`	Trace an image into curves.
`ra.relations`	Parent/child relations between parametric objects.
`ra.relief`	2.5D reliefs: creators, the operation stack, sculpt/smooth by points, bake, heightmaps.
`ra.smart_profile`	Smart Profiles: profile sections swept along a curve, varying along the way.
`ra.solid`	Solid modelling helpers: caps, shells, sweeps, offsets.
`ra.transform`	Move, rotate, scale, mirror, arrays, deformations (bend, twist, taper), flow, placement on objects.

Analysis and pricing

Module
`ra.analyze`	Wall thickness: at points and globally.
`ra.pricing`	Prices and cost breakdowns, markup and taxes profiles.
`ra.weight`	Metal weights: per layer, per selection, by area.

Production

Module
`ra.files`	File utilities: standardize, elements import/export, layer exports.
`ra.manufacturing`	Production: repair, printability checks, identifiers, sprues, resizing, exports.

Drafting

Module
`ra.drafting`	Reports, gems maps, cost tables, dimensions.

Render and views

Module
`ra.realtime_render`	The web Realtime Render viewer: open, update, camera, materials, screenshots.
`ra.render`	Render materials, staging and batch rendering.
`ra.render_studio`	Render Studio: environments, materials, stills and turntables.
`ra.view`	Viewport cameras, display modes, named views and captures.

Document and library

Module
`ra.assets`	The profile library the parametric tools build from.
`ra.document`	The document: open/save/new, computation mode, metals, ring size, STL/PDF/GLB exports.
`ra.elements`	Saved element presets: build from them, apply them, save objects as new ones, organize the library.
`ra.panels`	The open Artisan command panel: which one it is, and closing it without applying.
`ra.semantics`	Semantic descriptions of the design.

Integrations

Module
`ra.file_search`	Instant search over indexed design files.
`ra.nivoda`	Nivoda certified-diamond search.

Other

Module
`ra.ai_image`	AI images with fal.ai, the engine of Generative AI Studio and of the Assistant’s generate_image: a photoreal render of the viewport, an edit of an image file, or an image from a prompt alone.
`ra.anniversary`	Anniversary bands - a plain band with a row of touching bezel-set stones along the top (the ArtisanAnniversary tool).
`ra.boutique`	The Boutique: ready-made designs (solitaires, trilogies, halos, bands, earrings…) grouped in collections that are downloaded from the RhinoArtisan catalog to this computer and imported into the document like the Boutique window does.
`ra.time_tracking`	The time tracker’s records (the ArtisanTimeTracker panel), read-only: how long each saved file has been worked on, per day.
`ra.twisted_shank`	Twisted shanks - a solitaire band with plain shoulders under the head, two twisted strands on the sides, a plain back and a smooth inside (the ArtisanTwistedShank tool).