readme

   1 Hello! You must be new to all this so here's a rough breakdown of what is going on.
   2
   3 overview: http://adl.serveftp.org/dokuwiki/skdb
   4
   5 to download packages:
   6     sudo python clients/skdb-get.py lego
   7     sudo python clients/skdb-get.py screw
   8
   9 Completed features:
  10 - a simple example package describing a typical screw from the hardware store
  11   - the screw has a set of requirements for being manufactured
  12   - the package has a set of packages it needs to work right (threads package)
  13   - the package contains metadata such as homepage URL, author, copyright license
  14 - run /usr/local/share/skdb/lego/demo.py to demonstrate interface compatibility
  15 - run paths.py to demonstrate making a lego assembly
  16 - generate an assembly graph via igraph
  17
  18 here is a break down of the current directory structure:
  19
  20 config.yaml
  21     you need to edit this
  22
  23 clients/
  24     front-ends for ordering parts. later there will be tools here for doing pretend scenarios, generating instructions, or assembling armies of giant robots
  25
  26 core/
  27     code needed for loading, parsing, and drawing inferences from package data
  28
  29 geom/
  30     optional code to work with pythonOCC/OpenCASCADE
  31
  32 gui/
  33     optional code to work with pythonOCC/wxPython (graphical user interface)
  34
  35 doc/
  36     instructions for how to use SKDB (maybe some day)
  37
  38 doc/BOMs
  39     miscellaneous "required materials" lists for different fields of study (half-baked)
  40
  41 doc/proposals
  42     pseudo-code used by the developers to bounce ideas off each other
  43
  44 icons/
  45     generic representations of manufacturing techniques. this will move soon
  46
  47 import_tools/
  48     command line scripts that are used to convert from external file formats and databases
  49
  50 inventory/
  51     (mostly web-based) tools for managing your personal inventory, searching for resources in other locations, and data about various specific facilities and their access policy
  52
  53 packages/
  54     sample SKDB packages defining a set of artifacts, processes and stuff you can do with them
  55
  56 tests/
  57     run these after hacking to make sure you didn't break anything
  58
  59 ====
  60
  61 Links and learning more
  62
  63 homepage: http://adl.serveftp.org/dokuwiki/skdb
  64 git repository: http://adl.serveftp.org/skdb.git/
  65 repository contents: http://adl.serveftp.org/skdb/
  66 presentation: http://adl.serveftp.org/lab/presentations/updates-from-austin.pdf
  67 email: openmanufacturing@googlegroups.com
  68 IRC: #hplusroadmap on irc.freenode.net
  69