astongs / alloy

The PURE/Alloy project

PURE/Alloy

On November 20, 2019, at FINOS' flagship conference, the Open Source Strategy Forum, FINOS Platinum member Goldman Sachs announced its intention to open source two closely related products - its internal logical modeling language internally named "PURE", and a visual modeling platform that generates PURE models known in Goldman Sachs as "Alloy" - into FINOS.

More information about this decision and announcement can be found at https://www.finos.org/alloy.

Open Sourcing Roadmap

• Phase 0 (Q4 2019): Deploy an external instance of Alloy to AWS for Phase 1 shared modeling; announce the intention to open source PURE/Alloy at the Open Source Strategy Forum; internal code evaluation and preparation for open sourcing.

• Phase 1 (Q1 2020): Using the external instance of Alloy deployed in phase 0, with a group of bank pilot users, develop common, shared models, licensed under an Apache 2.0 license, written in PURE, likely collaborating first on a derivatives model. In this release, Studio will support the creation of data models, model-to-model mappings constraints and derivations. Continue to prepare code for open sourcing. Develop initial shared roadmap for PURE and Alloy extensions and new features for project developers to work on upon code being open sourced; identify and discuss priority areas for further collaborative model development.

• Phase 2 (Mid 2020): Complete technical and legal reviews of code for release per FINOS contribution process; make underlying PURE and Alloy code bases available as open source under an Apache 2.0 license into a FINOS GitLab or GitHub repository. Begin accepting pull requests into PURE and Alloy from developers outside Goldman Sachs.

For more information about PURE/Alloy, including some of the motivations behind the decision to open source these two products, see the PURE/Alloy press release.

Documentation Strategy

Alloy Documentation Site (alloy.finos.org)

The documentation site is built using Docusaurus based on the markdown files in the docs folder.

This Repository - GitHub.com (github.com/finos/alloy)

This repository (github.com/finos/alloy) hosts:

• The underling files for the Alloy Documentation site (composed in markdown file format and stored in the docs/ folder)
• The shared issues list used for task management to track project activity around documentation, deployments, and the overall effort associated with open sourcing PURE and Alloy
• These issues are organized in various kanban boards, including the overall project kanban.

FINOS Hosted GitLab Repository (gitlab.alloy.finos.org)

A separate hosted Gitlab repository, gitlab.alloy.finos.org hosts shared models being developed by the Alloy project pilot team.

gitlab.com (https://gitlab.com/finosfoundation)

Documentation specific to particular families and groups of models will be created and curated on GitLab.com at https://gitlab.com/finosfoundation. In Phase 2, it's possible that the shared model definitions themselves may be migrated from the hosted GitLab instance to Gitlab.com.

Contributing

See our CONTRIBUTING.md

Installation

(Coming Soon; Information on running and installing your own instance of Alloy, either on premise or in a cloud provider such as AWS, Azure, OpenShift, Google, etc.)

Usage example

(Coming Soon)

Development setup

(Coming Soon)

License

Copyright 2020 Goldman Sachs

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0