Getting Started

How to get started with the Macrosynergy package in 5-minutes.

Installation

The easiest method for installing the package is to use the PyPI installation method:

Installing from PyPI

pip install macrosynergy

Alternatively, if you want to install the latest development version, you can install directly from GitHub:

Installing from GitHub/Source

pip install git+https://github.com/macrosynergy/macrosynergy@develop

This extends to any branch; not just the develop branch.

Building from Source

If you want to build the package from source, you would need to clone the repository and run the build command:

git clone https://github.com/macrosynergy/macrosynergy
cd macrosynergy
python setup.py build

Usage

The package is designed to be used in conjunction with JPMaQS Quantamental Data from the J.P. Morgan DataQuery API. If you do not have access to the DataQuery API, you can still use the package with simulated data from macrosynergy.management.simulate.

Development and Contribution

The Macrosynergy package is an open-source project. We welcome contributions of all kinds, from simple bug reports through to new features and documentation improvements. This document outlines the process for contributing to the project.

You can find the source code for the package on GitHub at: macrosynergy/macrosynergy.

If you would like to contribute to the project, please read the Contribution guide .