https://github.com/martian-lang/martian

Language and framework for high performance computational pipelines.
https://github.com/martian-lang/martian

Last synced: 2 months ago
JSON representation

Language and framework for high performance computational pipelines.

• Host: GitHub
• URL: https://github.com/martian-lang/martian
• Owner: martian-lang
• License: mit
• Created: 2017-06-20T22:14:53.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-29T22:09:20.000Z (6 months ago)
• Last Synced: 2024-07-30T03:52:57.914Z (6 months ago)
• Language: Go
• Homepage: http://martian-lang.org
• Size: 9.97 MB
• Stars: 147
• Watchers: 12
• Forks: 20
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• awesome-ccamel - martian-lang/martian - Language and framework for high performance computational pipelines. (Go)

README

        


  

    

  

  


    Language and framework for developing high performance computational pipelines.

  


[![GoDoc](https://godoc.org/github.com/martian-lang/martian?status.svg)](https://godoc.org/github.com/martian-lang/martian)

[![Build Status](https://github.com/martian-lang/martian/actions/workflows/test.yml/badge.svg)](https://github.com/martian-lang/martian/actions/workflows/test.yml)

## Getting Started

Please see the [Martian Documentation](http://martian-lang.org).

The easiest way to get started is

```sh

$ git clone https://github.com/martian-lang/martian.git

$ cd martian

$ make

```

Alternatively, build with [bazel](https://bazel.build):

```sh

$ bazel build //:mrp

```

Note that while `go get` will not work very well for this repository, because it

will skip fetching the web UI and runtime configuration files, and because this

repository had already tagged version 3 by the time go modules came around, and

is thus not following the expected go conventions for how code is organized for

non-v1 versions.

### Note on semantic versioning

Semantic versioning for martian is based on pipeline compatibility, not the Go

API.  That is, a major version change indicates that pipelines (defined in

`.mro` files) may no longer function correctly.  This unfortunately poses problems

with go modules, (which didn't exist yet at the time v3 was first tagged) which

exepect version tags to be referring to the semver compatibility of the Go API.

We hope to rectify this in v5, but ironically that will force an

backwards-incompatible change to the Go API.  In the mean time, if you wish to

depend on martian as a go module, use the git commit rather than a version tag.

## Copyright and License

Code and documentation copyright 2014-2017 the [Martian Authors](https://github.com/martian-lang/martian/graphs/contributors) and [10x Genomics, Inc.](https://10xgenomics.com) Code released under the [MIT License](https://github.com/martian-lang/martian/blob/master/LICENSE). Documentation released under [Creative Commons](https://github.com/martian-lang/martian-docs/blob/master/LICENSE).