Welcome to CQ.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<div class=\"clearfix\" style=\"padding: 10px; padding-left: 10px\">\n",
    "<img src=\"https://raw.githubusercontent.com/jupyter/nature-demo/master/images/jupyter-logo.png\" width=\"150px\" style=\"display: inline-block; margin-top: 5px;\">\n",
    "<a href=\"http://dcowden.github.io/cadquery/\"><img src=\"https://dcowden.github.io/cadquery/_static/logo/cadquery_logo_dark.svg\" width=\"150px\" class=\"pull-right\" style=\"display: inline-block; margin: 0px;\"></a>\n",
    "</div>\n",
    "\n",
    "## Try CadQuery \n",
    "\n",
    "This Notebook Server was **launched just for you**. It's purpose is to allow you to try out CadQuery before you decide to set it up for yourself. \n",
    "\n",
    "There are several different methods for using CadQuery that don't require Jupyter Notebooks, but the philosphy behind Jupyter fits nicely with what CadQuery aims to achieve. As such, we hope you enjoy using it here!\n",
    "\n",
    "<div class=\"alert alert-warning\" role=\"alert\" style=\"margin: 10px\">\n",
    "<p>**ATTENTION**</p>\n",
    "\n",
    "<p>Don't rely on this server for anything you want to last - your server will be *deleted after a few minutes of inactivity*.</p>\n",
    "</div>\n",
    "\n",
    "\n",
    "CadQuery has a small yet growing community, so things may not be perfect here. If you see something wrong, or have suggestions for improvements, feel free to do any of the following:\n",
    "\n",
    "* post an issue on [CadQuery's Github](https://github.com/dcowden/cadquery)\n",
    "* post an issue on [This repo's Github](https://github.com/RustyVermeer/tryCQ)\n",
    "* head to the [CadQuery Forum](https://groups.google.com/forum/#!forum/cadquery) and read / post there. There are several helpful folks over there who love it when new people enter the community!\n",
    "* [reach Adam on Twitter](https://twitter.com/rustyvermeer) and send a message and/or tweet, if you'd like.\n",
    "\n",
    "\n",
    "## Sources and Credit\n",
    "\n",
    "* Server uses [myBinder.org](https://mybinder.org/).\n",
    "* [CadQuery](https://github.com/dcowden/cadquery) is the library being demoed. [Contributers](https://github.com/dcowden/cadquery/graphs/contributors). It is currently using [FreeCAD](https://www.freecadweb.org/) as the backend.\n",
    "* [CQNB](https://github.com/RustyVermeer/cqnb) is the module that allows Jupyter Notebooks to display CadQuery scripts. It relies upon:\n",
    "    * [pythreejs](https://github.com/jovyan/pythreejs). [Contributers](https://github.com/jovyan/pythreejs/graphs/contributors)\n",
    "    * [ipywidgets](https://github.com/jupyter-widgets/ipywidgets). [Contributers](https://github.com/jupyter-widgets/ipywidgets/graphs/contributors)\n",
    "    \n",
    "Some of the content within this notebook is based on the notebook [here](https://github.com/jupyter/docker-demo-images/blob/master/notebooks/Welcome%20to%20Python.ipynb).\n",
    "\n",
    "The example notebooks are all taken from the [CadQuery example scripts](https://github.com/dcowden/cadquery/tree/master/examples/FreeCAD), which have been compiled over time by various users and contributers.\n",
    "\n",
    "Many thanks to the efforts of all people involved with each part of this. :)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Totally new to Jupyter?\n",
    "\n",
    "Don't worry, the basics are nice and simple to grasp :). \n",
    "\n",
    "Jupyter's main page provides a file browser, allowing you to select folders and files. The most interesting of which are *notebook* files with the file extension **.ipynb**. You're interacting with one such file now, in fact.\n",
    "\n",
    "Inside a notebook you have a view of *cells* which can contain either text or code. This cell is a *markdown* cell used for inline explanations and documentation. The cell below is a *code* cell, which is interpreted by the **kernel** as python code. If you ever set up your own installation, you will have the ability to install different kernels that allow you to create notebooks for different languages. Powerful stuff!\n",
    "\n",
    "You can use the menus at the top of the notebook to add and change cells. Play around a bit and see what you can do! \n",
    "\n",
    "Feel free to open new cells using the plus button (<button class='fa fa-plus icon-plus btn btn-xs btn-default'></button>), or hitting shift-enter while this cell is selected.\n",
    "\n",
    "Behind the scenes, the software that powers this is [tmpnb](https://github.com/jupyter/tmpnb), a  Tornado application that spawns [pre-built Docker containers](https://github.com/ipython/docker-notebook) and then uses the [jupyter/configurable-http-proxy](https://github.com/jupyter/configurable-http-proxy) to put your notebook server on a unique path.\n",
    "\n",
    "## Totally new to CadQuery?\n",
    "\n",
    "That's cool, too. It's a good thing you're here, then! \n",
    "\n",
    "Have a look through the examples folder to get a hang of the library.\n",
    "In order to get a nice display of the geometry, you'll have to follow this simple sequence of steps:\n",
    "\n",
    "1. Highlight the cell containing the CadQuery (often shortened to CQ) script. \n",
    "2. Press CTRL + ENTER or hit the RUN button.\n",
    "3. Once the cell is run, you'll see a few boxes input boxes that appear alongside a *Run Interact* button. Click the button.\n",
    "4. Have a look at your Geometry! Scroll wheel will zoom in and out. Hold Left click and drag to rotate the object around. Hold Right Click and drag to shift the frame.\n",
    "5. Change values around in the inputs and press *Run Interact* again to regenerate a new geometry. Re-run the cell to reset everything.\n",
    "\n",
    "<center><video style=\"margin-left: 0;\" width=\"628\" height=\"780\" controls loop src=\"use_cq.mp4\" type=\"video/mp4\"></video></center>\n",
    "\n",
    "Once you can see some output, you'll likely want to try writing your own script. The best resource for learning the various functions of CadQuery is the [documentation](http://dcowden.github.io/cadquery/index.html).\n",
    "\n",
    "There's always room to improve the documentation, of course so if you run into confusion or lack of documentation, your next best bet is to [dive into the code](https://github.com/dcowden/cadquery). It's well written, so we hope you'll be able to grasp the details well enough to proceed. \n",
    "\n",
    "As always, feel free to provide feedback. Contribution from everyone makes the open source community extremely valuable. We love working together!"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 2",
   "language": "python",
   "name": "python2"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.14"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}