MetaForge

HyperThought Data/MetaData Uploading program.

Binaries are located at https://github.com/BlueQuartzSoftware/MetaForge/releases.

How to Install Using Anaconda

Users

NOTE: This assumes that you have Anaconda running on your system, and you are running either MacOS or 64-bit Windows.

1. Create and activate a new python 3.8 Anaconda environment:

  conda create -n metaforge python=3.8
  conda activate metaforge

2. Add the dependency channels to your channel list:

  conda config --add channels conda-forge
  conda config --add channels hyperthought

3. Install the metaforge package from the BlueQuartz Software Anaconda channel:

  conda install -c bluequartzsoftware metaforge

4. Launch the application:

  metaforge

Developers

NOTE: This assumes that you have Anaconda and Git running on your system.

1. Clone down the MetaForge project from GitHub:

  git clone https://www.github.com/bluequartzsoftware/MetaForge

2. Create and activate a new Anaconda environment using the environment yaml file:

  cd MetaForge
  conda env create -f environment.yml
  conda activate metaforge

3. Install the metaforge package as an editable package:

  pip install -e .

4. Launch the application:

  metaforge

NOTE: If you are using Visual Studio Code as your IDE, you can paste this into your launch.json file to be able to easily debug MetaForge:

  {
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: MetaForge",
            "type": "python",
            "request": "launch",
            "program": "metaforge",
            "console": "integratedTerminal"
        }
    ]
  }

Creating a Standalone App Package:

From within the metaforge virtual environment: conda install pyinstaller

Navigate to the top level of the MetaForge repository, and then execute the following:

For MacOS: pyinstaller --clean packaging/macOS.spec

For Windows: pyinstaller --clean packaging/win64.spec

The standalone package is located in the dist folder at the top level of the MetaForge repo.

Current Bugs

https://github.com/BlueQuartzSoftware/MetaForge/issues