SOuP (plug-in for Maya) © soup-dev LLC

installation
------------
1. Place the contents of SOuP.tar.gz in a desired directory.
2. For Windows run setup.exe, for Linux/OSX run setup (executable script).
3. Windows only! Install "Visual C++ Redistributable for Visual Studio 2015", or later version.

licensing
---------
1. Host ID is a specific piece of information which uniquely identifies a computer. It is required by the SOuP license generators to create valid licenses. There are 3 different ways to obtain the Host ID:
   1.1 Load SOuP in Maya, open Script Editor, look for line like this: "SOuP: Host ID (mac address): ############" <- this number is the Host ID of the computer.
   1.2 Load SOuP in Maya, click on SOuP/OVDB drop-down menu -> print host id.
   1.3 Use the standard OS commands:
       linux/osx: ifconfig
       windows: ipconfig
2. To obtain a license:
   2.1 Purchase the type and amount of licenses from www.soup-dev.com/support.html
   2.2 Send email to sales@soup-dev.com that includes:
      - purchase order
      - for standalone licenses - host ids of the workstations that will run SOuP
      - for floating licenses - host id of the computer hosting the RLM license server
   2.3 Licenses are issued by email shortly after purchase.
3. Trial license:
   3.1 Trial license is valid for 15 days only. After that the SOuP plug-in will become inactive.
   3.2 Internet connection is required for SOuP to operate in this mode.
   3.3 License is obtained automatically without user intervention. Disregard #1 and #2.
4. Installing a standlone (node locked) license:
   4.1 Place the license file inside directory:
       linux:   /home/$USER/maya/
       windows: c:\users\$USER\documents\maya\
       osx:     /Users/$USER/Library/Preferences/Autodesk/maya/
    4.2 If for some reason the license file has to be located inside another directory, use environment variable RLM_LICENSE to point to it (the directory).
5. Installing a floating license:
   5.1 Place the license file inside the RLM server directory.
   5.2 If for some reason the license file has to be located inside another directory, use environment variable RLM_LICENSE to point to it (the directory).
   5.3 Start the RLM server and make sure that no firewall is blocking it.
   5.4 License server administration:
      5.4.1 Open an internet browser on the computer where the RLM server is running and type "localhost:5054" in the URL field. This will show you the RLM administration options, where you can check the status of a license, see which computers are using licenses, or stop/start the server etc.
      5.4.2 To change the default RLM license port if other applications are already using it - edit the first line of your license file and change port 5053 to something else, then restart the RLM server.
      5.4.3 If there is an RLM server running, simply put the floating license file next to the other license files already in use and restart the server.
      5.4.4 For more detailed information visit http://www.reprisesoftware.com/RLM_Enduser.html
   5.5. If the RLM server and clients are on a different sub-networks, make the server visible by setting environment variable soupdev_LICENSE to its address and port, for exampe soupdev_LICENSE=192.168.5.5@1234.

getting started
---------------
1. Launch Maya.
2. Load the SOuP plug-in.
3. Explore the SOuP/OVDB menu on the main Maya toolbar.

software license dependencies
-----------------------------
AudioToArray and CGAL are under GPL license.
TetGen node is under AFFERO GPL license.
WT and Nanoflan are under BSD license.
FFTW, PoissonRecon and Quadriflow are under MIT license.
Boost, Lemon, B-Mesh and WM5 are under Boost Software license.
Eigen is under MPL2 license.

credits
-------
WT by Theodore Kim and Nils Thuerey.
B-Mesh project by Evan Wallace, Justin Ardini and Lance Jabr.
Audio Analysis by Vincent Houze.
TetGen by Hang Si.
KdTree is based on example Maya command by Jerome Ledrole.
Nanoflann by Jose Luis Blanco-Claraco.
Predicates and PoissonRecon by Jonathan Shewchuk, Michael Kazhdan, Matthew Bolitho.
SmartConnect (marking menu system) is based on a prototype by David Ryberg Lessel.
Simon Yuen came up with the original idea and heavily contributed to the development of the Mate deformer.
Quadriflow by Jingwei Huang and Yichao Zhou.

Node IDs:
------------------------------------
MUSCLE                    0x00115740
TENSIONMAP                0x00115741
GROUP                     0x00115742
BOUNDINGOBJECT            0x00115743
OBJGRPTOCOMPLIST          0x00115744
COMPLISTTOOBJGRP          0x00115745
PEAK                      0x00115746
STICKYCURVES              0x00115747
ARRAYTOMULTI              0x00115748
POINT                     0x00115749
ARRAYEXPRESSION           0x0011574A
DISPLAYCOMPONENTS         0x0011574B
BOUNDINGOBJECTMANIP       0x0011574C
TEXTURETOARRAY            0x0011574D
MULTIREMAPVALUE           0x0011574E
REMAPARRAY                0x0011574F
ATTRIBUTETRANSFER         0x00115750
MULTIATTRIBUTETRANSFER    0x00115751
POINTCLOUDFLUIDEMITTER    0x00115752
POINTCLOUDFIELD           0x00115753
POINTATTRIBUTETOARRAY     0x00115754
TIMEOFFSET                0x00115755
MULTITOARRAY              0x00115756
BOUND                     0x00115757
COMPUTEVELOCITY           0x00115758
MIRRORPLANE               0x00115759
FLUIDATTRIBUTETOARRAY     0x0011575A
ARRAYTOPOINTCOLOR         0x0011575B
POINTCLOUDTOCURVE         0x0011575C
TRAJECTORY                0x0011575D
VERTEXCONSTRAINT          0x0011575E
ARRAYTOARRAY              0x0011575F
DISPLAYATTRIBUTES         0x00115760
ARRAYDATACONTAINER        0x00115761
SCATTER                   0x00115762
SHATTER                   0x00115763
ARRAYTODYNARRAYS          0x00115764
RGBATOCOLORANDALPHA       0x00115765
UPRESFLUID                0x00115766
PFXTOARRAY                0x00115767
PROJECTIONPLANE           0x00115768
RAYPROJECT                0x00115769
RETARGET                  0x0011576A
POINTSONMESHINFO          0x0011576B
CAGE                      0x0011576C
VORONOITEXTURE            0x0011576D
ARRAYTOTEXTURE            0x0011576E
DISPLAYDRIVER             0x0011576F
SMOOTH                    0x00115770
PYEXPRESSION              0x00115771
MAPTOMESH                 0x00115772
MESHTOMAP                 0x00115773
POINTCLOUDTOMULTICURVE    0x00115774
ARRAYBLEND                0x00115775
COMPONENTTOCOMPONENT      0x00115776
SPLITRGBA                 0x00115777
FRAMECACHER               0x00115778
CREATEARRAY               0x00115779
POINTCLOUDPARTICLEEMITTER 0x00115780
BMESH                     0x0011578A
SHELL                     0x0011578B
RESIZEARRAY               0x0011578C
TENSIONMAPSIMPLE          0x0011578D
POINTCLOUDTOMESH          0x0011578E
TRANSFORMSTOARRAYS        0x0011578F
COCOON                    0x00115790
TENSIONBLENDSHAPE         0x0011579A
UVTENSION                 0x0011579B
FRAMECACHETRACKER         0x0011579C
CONVEXHULL                0x0011579D
MORPHASSEMBLY             0x0011579E
MORPH                     0x0011579F
COPIER                    0x001157A0
MESH2ARRAYS               0x001157A1
COMBINEARRAYS             0x001157A2
BLURPOINTATTRIBUTE        0x001157A3
VOXELGRID                 0x001157A4
EXTRACTOR                 0x001157A5
COLORANDALPHATORGBA       0x001157A6
RAYPROJECTXFORM           0x001157A7
UVSTOPOINTSONMESH         0x001157A8
MERGEARRAYS               0x001157A9
AUDIOTOARRAY              0x001157AA
TETRAHEDRALIZE            0x001157AB
ATTRFRAMECACHER           0x001157AC
SMOOTHSIMPLE              0x001157AD
GPUCACHER                 0x001157AE
MNGGPUCACHER              0x001157AF
CAPE                      0x001157B0
SPEEDOMETER               0x001157B1
CURVESTOPOINTCLOUD        0x001157B2
BLENDCURVES               0x001157B3
CURLNOISEFIELD            0x001157B4
RANDOMIZEARRAY            0x001157B5
FACECENTERS               0x001157B6
MERGEVECTORARRAYS         0x001157B7
COLLIDE                   0x001157B8
KDTREE                    0x001157B9
REMESH                    0x001157BA
RESOLVESELFINTERSECTIONS  0x001157BB
SKELETONIZE               0x001157BC
SHORTESTPATH              0x001157BD
RESOLVEPOINTCOLLISIONS    0x001157BE
RESAMPLE                  0x001157BF
SOLVER                    0x001157C0
SURFACEFLOW               0x001157C1
ARRAYTOPOINTATTRIBUTE     0x001157C2
POINTCLOUDFLOW            0x001157C3
EDGEATTRIBUTETOARRAY      0x001157C4
OUTLINE                   0x001157C5
DECIMATEARRAY             0x001157C6
SMARTFILLHOLE             0x001157C7
NCACHEINTERPOLATOR        0x001157C8
MATE                      0x001157C9
