Skip to content

Latest commit

 

History

History
109 lines (71 loc) · 4.68 KB

BUILD.md

File metadata and controls

109 lines (71 loc) · 4.68 KB
Raw

Building OpenMETA

OpenMETA can be compiled from the source code in this repository. Compilation requires a Windows PC and access to the internet (for downloading NuGet packages).

Build Machine Setup

Follow these configuration instructions, in order, to set up your machine to build OpenMETA from source.

Windows x64 (7 SP3, 8.1, 10 or Server equivalent)

Install Windows updates until your version is current

Microsoft Visual Studio

The solution will build with Microsoft Visual Studio 2015 or 2017.

If you have Visual Studio 2017 (Community or above)

NOTE: Will not compile with Visual Studio Code

When installing Visual Studio, select these packages (at minimum):

  • C++
  • C#

You must also install:

  • Visual Studio 2015 Build Tools (download)
  • Visual C++ 2015 Build Tools (download)
    • Select the "ATL/MFC SDK" package (at minimum)

If you have Visual Studio 2015 (Community or above)

NOTE: Will not compile under Express Edition

When installing Visual Studio, select these packages (at minimum):

  • C++
  • C#

You must also install Microsoft Visual Studio 2015 Update 3 (download)

.NETFramework Version 4.6.2 Developer Pack

Visual Studio Installer -> Modify -> Individual Components -> .NET Framework 4.6.2 Developer Pack

Java JDK version 8 to 11

Download it here

or https://adoptium.net/download/

NOTE: Either x86 or x64 is okay

Set JAVA_HOME

Set environment variable JAVA_HOME to the installed directory, such as C:\Program Files (x86)\Java\jdk1.7.0_09

The actual name of the subdirectory depends on what version you have installed.

GME 16.3+

Download it here

GME_x64 is the best-tested (but 32-bit should work too)

UDM x64 3.2.14+

Download it here

Windows Updates

Again, install Windows updates until everything is current. Restart your computer.

FreeCAD

FreeCAD is an open-source parametric 3D CAD modeling program. META uses FreeCAD to assemble component CAD models to provide a 3D visual representation of a user's model. It is required for the CyPhy2CADPCB visualizing test benches.

Download FreeCAD v0.14 x64.

CadQuery

CadQuery is a plugin for FreeCAD that provides a library of Python functions for the manipulation of solid geometry. These functions are used to transform the local coordinate system of a component's CAD model to the correct position and orientation in the assembly coordinate system. It is required for the CyPhy2CADPCB visualizing test benches.

Download CadQuery.

To install:

  • Download zip file above and extract contents.
  • Copy the CadQuery folder into <FreeCAD_Install_Dir>\Mod

NOTE: The CadQuery library must be copied into the <FreeCAD_Install_Dir>\Mod folder to work correctly with the META tools.

EAGLE

For the tests to pass, EAGLE must be installed.

Download EAGLE. Version 6.5 is known to work.

OpenEMS

For the tests to pass, OpenEMS must be installed to C:\OpenEMS

Download OpenEMS Version 0.32 is known to work.

Git

Download msysgit

git.exe must be in your PATH. For msysgit, select Use Git from the Windows Command Prompt during installation.

Clone Repo

Clone this repository to your disk.

Build

  1. Open Visual Studio Command Prompt (2015 or 2017) with "Run as administrator". (Do not use "x64 Native Tools Command Prompt" or "x86 x64 Cross Tools Command Prompt")
  2. From the root repository directory, run build_both.cmd. This may take 30 minutes to build. (Warnings may be ignored, but there should be no errors.)

If you encounter errors, try to build once more. There may be some remaining race conditions in the build scripts.

Run

First-time users should read the Documentation to learn about the tools.
Simple step-by-step tutorials can be found in Tutorials section.
More advanced capabilities are explored in the Walkthroughs section.

Installer

Run bin\Python27\Scripts\python.exe deploy\build_msi.py to build the installer.