https://github.com/aliceo2group/control
AliECS - The ALICE Experiment Control System
Science Score: 39.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.1%) to scientific vocabulary
Last synced: 10 months ago
·
JSON representation
Repository
AliECS - The ALICE Experiment Control System
Basic Info
Statistics
- Stars: 7
- Watchers: 6
- Forks: 23
- Open Issues: 3
- Releases: 289
Created about 9 years ago
· Last pushed 10 months ago
Metadata Files
Readme
Contributing
License
Codeowners
README.md
AliECS
The ALICE Experiment Control System (AliECS) is the piece of software to drive and control data taking activities in the experiment. It is a distributed system that combines state of the art cluster resource management and experiment control functionalities into a single comprehensive solution.
Please refer to the CHEP 2023 paper for the latest design overview.
How to get started
Regardless of your particular interests, it is recommended to get acquainted with the main AliECS concepts.
After that, please find your concrete use case:
I want to run AliECS and other O²/FLP software
See O²/FLP Suite deployment instructions
These instructions apply to both single-node and multi-node deployments. Contact alice-o2-flp-support for assistance with provisioning and deployment.
There are two ways of interacting with AliECS:
- The AliECS GUI (a.k.a. Control GUI, COG) - not in this repository, but included in most deployments, recommended
:arrow_right: AliECS GUI documentation
coconut- the command-line control and configuration utility, included with AliECS core, typically for developers and advanced users
:arrow_right: Using coconut
:arrow_right: coconut command reference
I want to ensure AliECS can run and control my process
My software is based on FairMQ and/or O² DPL (Data Processing Later)
AliECS natively supports FairMQ (and DPL) devices. Head to ControlWorkflows for instructions on how to configure your software to be controlled by AliECS.
My software does not use FairMQ and/or DPL, but should be controlled through a state machine
See the OCC documentation to learn how to integrate the O² Control and Configuration library with your software. Readout is an example of this setup.
Once ready, head to ControlWorkflows for instructions on how to configure it to be controlled by AliECS.
My software is a command line utility with no state machine
AliECS natively supports generic commands. Head to ControlWorkflows for instructions to have your command ran by AliECS. Make sure the task template for your command sets the control mode to
basic(see example).
I want to develop AliECS
:hammerandwrench: Welcome to the team, please head to contributing instructions
I want to receive updates about environments or services controlled by AliECS
:pager: Learn more about the kafka event service
I want my application to send requests to AliECS
:scroll: See the API docs of AliECS components:
I want my service to be sent requests by AliECS
:electric_plug: Learn more about the plugin system
Table of Contents
Introduction
Component reference
- AliECS GUI
- AliECS GUI overview
- AliECS core
- Workflow Configuration
- Task Configuration
- Integration plugins
- Integrated service operations
- Environment operation order
- Protocol documentation
- coconut
- The O² control and configuration utility overview
- Command reference
- apricot
- ALICE configuration service overview
- HTTP service
- Protocol documentation
- Command reference
- occ
- O² Control and Configuration Components
- Dummy process example for OCC library
- Protocol documentation
- peanut
- Process control and execution utility overview
- Event service
- Kafka producer functionality in AliECS core
- Legacy events: Kafka plugin
Developer documentation
- Contributing
- Package pkg.go.dev documentation
- Building AliECS
- Overview
- Building with aliBuild
- Manual build
- Makefile reference
- Component Configuration
- Apache Mesos
- Running AliECS as a developer
- Running the AliECS core
- Running AliECS in production
- Health checks
- Development Information
- Release Procedure
- Metrics in ECS
- Overview and simple usage
- Types and aggregation of metrics
- Implementation details
- OCC API debugging with grpcc
Resources
- T. Mrnjavac et. al, AliECS: A New Experiment Control System for the ALICE Experiment, CHEP23
Owner
- Name: AliceO2Group
- Login: AliceO2Group
- Kind: organization
- Repositories: 55
- Profile: https://github.com/AliceO2Group
GitHub Events
Total
- Release event: 31
- Delete event: 50
- Issue comment event: 58
- Push event: 184
- Pull request review comment event: 88
- Pull request review event: 202
- Pull request event: 194
- Create event: 100
Last Year
- Release event: 31
- Delete event: 50
- Issue comment event: 58
- Push event: 184
- Pull request review comment event: 88
- Pull request review event: 202
- Pull request event: 194
- Create event: 100
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 2
- Total pull requests: 318
- Average time to close issues: about 2 hours
- Average time to close pull requests: 21 days
- Total issue authors: 2
- Total pull request authors: 12
- Average comments per issue: 0.0
- Average comments per pull request: 0.33
- Merged pull requests: 251
- Bot issues: 0
- Bot pull requests: 13
Past Year
- Issues: 0
- Pull requests: 129
- Average time to close issues: N/A
- Average time to close pull requests: 4 days
- Issue authors: 0
- Pull request authors: 7
- Average comments per issue: 0
- Average comments per pull request: 0.42
- Merged pull requests: 91
- Bot issues: 0
- Bot pull requests: 6
Top Authors
Issue Authors
- justonedev1 (1)
- teo (1)
Pull Request Authors
- knopers8 (118)
- teo (84)
- justonedev1 (62)
- claireguyot (26)
- dependabot[bot] (13)
- kostorr (5)
- Copilot (3)
- ktf (2)
- dvoscek (2)
- graduta (1)
- rdivia (1)
- davidrohr (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (13)
go (5)
enhancement (1)
Packages
- Total packages: 2
- Total downloads: unknown
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 529
proxy.golang.org: github.com/AliceO2Group/Control
- Homepage: https://github.com/AliceO2Group/Control
- Documentation: https://pkg.go.dev/github.com/AliceO2Group/Control#section-documentation
- License: GPL-3.0
-
Latest release: v1.23.2
published over 1 year ago
Rankings
Forks count: 3.1%
Average: 6.5%
Stargazers count: 6.5%
Dependent packages count: 7.0%
Dependent repos count: 9.3%
Last synced:
over 1 year ago
proxy.golang.org: github.com/aliceo2group/control
- Documentation: https://pkg.go.dev/github.com/aliceo2group/control#section-documentation
- License: gpl-3.0
-
Latest release: v1.42.0
published 10 months ago
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced:
10 months ago
Dependencies
go.mod
go
- cloud.google.com/go v0.76.0
- cloud.google.com/go/firestore v1.4.0
- github.com/AlecAivazis/survey/v2 v2.2.7
- github.com/AliceO2Group/Bookkeeping v0.17.13-0.20220708054416-8f6ce27ae168
- github.com/AliceO2Group/Bookkeeping/go-api-client v0.0.0-20220708054416-8f6ce27ae168
- github.com/BurntSushi/xgb v0.0.0-20210121224620-deaf085860bc
- github.com/Masterminds/goutils v1.1.1
- github.com/Masterminds/semver v1.5.0
- github.com/Masterminds/sprig v2.22.0+incompatible
- github.com/Microsoft/go-winio v0.4.16
- github.com/alecthomas/units v0.0.0-20210208195552-ff826a37aa15
- github.com/antlr/antlr4 v0.0.0-20191011202612-ad2bd05285ca
- github.com/antonmedv/expr v1.8.9
- github.com/aokoli/goutils v1.1.1
- github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6
- github.com/armon/go-metrics v0.3.6
- github.com/bketelsen/crypt v0.0.3
- github.com/briandowns/spinner v1.12.0
- github.com/census-instrumentation/opencensus-proto v0.3.0
- github.com/cncf/udpa/go v0.0.0-20210210032658-bff43e8824d0
- github.com/coreos/bbolt v1.3.4
- github.com/coreos/etcd v3.3.25+incompatible
- github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf
- github.com/coreos/go-systemd=>github.com/coreos/go-systemd/v22 v22.0.0
- github.com/deckarep/golang-set v1.7.1
- github.com/denisbrodbeck/machineid v1.0.1
- github.com/dmarkham/enumer v1.5.2
- github.com/dustin/go-humanize v1.0.0
- github.com/envoyproxy/go-control-plane v0.9.8
- github.com/envoyproxy/protoc-gen-validate v0.4.1
- github.com/fatih/color v1.10.0
- github.com/fatih/structs v1.1.0
- github.com/flosch/pongo2/v4 v4.0.2
- github.com/gdamore/tcell/v2 v2.1.0
- github.com/gliderlabs/ssh v0.3.0
- github.com/go-git/go-git/v5 v5.2.0
- github.com/go-gl/glfw/v3.3/glfw v0.0.0-20201108214237-06ea97f0c265
- github.com/go-yaml/yaml v2.1.0+incompatible
- github.com/gobwas/glob v0.2.3
- github.com/golang/protobuf v1.5.2
- github.com/google/uuid v1.2.0
- github.com/gopherjs/gopherjs v0.0.0-20200217142428-fce0ec30dd00
- github.com/gorilla/mux v1.7.3
- github.com/grpc-ecosystem/go-grpc-middleware v1.2.0
- github.com/grpc-ecosystem/grpc-gateway v1.14.3
- github.com/hashicorp/consul/api v1.8.1
- github.com/hashicorp/go-cleanhttp v0.5.2
- github.com/hashicorp/go-hclog v0.15.0
- github.com/hashicorp/go-immutable-radix v1.3.0
- github.com/hashicorp/go-msgpack v0.5.5
- github.com/hashicorp/go-sockaddr v1.0.2
- github.com/hashicorp/go-uuid v1.0.2
- github.com/hashicorp/golang-lru v0.5.4
- github.com/huandu/xstrings v1.3.2
- github.com/imdario/mergo v0.3.11
- github.com/jinzhu/copier v0.2.4
- github.com/k0kubun/colorstring v0.0.0-20150214042306-9440f1994b88
- github.com/k0kubun/pp v3.0.1+incompatible
- github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351
- github.com/klauspost/compress v1.15.2
- github.com/kylelemons/godebug v1.1.0
- github.com/looplab/fsm v0.2.0
- github.com/lucasb-eyer/go-colorful v1.2.0
- github.com/magiconair/properties v1.8.4
- github.com/mesos/mesos-go v0.0.11
- github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d
- github.com/miekg/dns v1.1.29
- github.com/mitchellh/copystructure v1.1.1
- github.com/mitchellh/go-homedir v1.1.0
- github.com/mitchellh/mapstructure v1.4.1
- github.com/naoina/go-stringutil v0.1.0
- github.com/naoina/toml v0.1.1
- github.com/nxadm/tail v1.4.8
- github.com/olekukonko/tablewriter v0.0.5
- github.com/onsi/ginkgo v1.15.0
- github.com/onsi/gomega v1.10.5
- github.com/osamingo/indigo v1.1.0
- github.com/osteele/liquid v1.2.4
- github.com/osteele/tuesday v1.0.3
- github.com/pascaldekloe/name v1.0.1
- github.com/pborman/uuid v1.2.1
- github.com/pelletier/go-toml v1.8.1
- github.com/pkg/sftp v1.12.0
- github.com/pquerna/ffjson v0.0.0-20190930134022-aa0246cd15f7
- github.com/pressly/chi v0.0.0-00010101000000-000000000000
- github.com/prometheus/client_golang v1.9.0
- github.com/pseudomuto/protoc-gen-doc v1.4.1
- github.com/rivo/tview v0.0.0-20210125085121-dbc1f32bb1d0
- github.com/rs/xid v1.2.1
- github.com/russross/blackfriday/v2 v2.1.0
- github.com/segmentio/kafka-go v0.4.31
- github.com/sirupsen/logrus v1.8.1
- github.com/smartystreets/assertions v1.0.1
- github.com/spf13/afero v1.5.1
- github.com/spf13/cast v1.3.1
- github.com/spf13/cobra v1.1.3
- github.com/spf13/jwalterweatherman v1.1.0
- github.com/spf13/pflag v1.0.5
- github.com/spf13/viper v1.7.1
- github.com/stretchr/testify v1.7.0
- github.com/teo/logrus-prefixed-formatter v0.0.0-20171201112440-d4c78d981295
- github.com/tmc/grpc-websocket-proxy v0.0.0-20200122045848-3419fae592fc
- github.com/ugorji/go v1.1.4
- github.com/valyala/fasttemplate v1.2.1
- github.com/x-cray/logrus-prefixed-formatter v0.5.2
- github.com/xanzy/ssh-agent v0.3.0
- github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb
- github.com/xeipuuv/gojsonschema v1.2.0
- github.com/xlab/treeprint v1.0.0
- github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77
- github.com/yuin/goldmark v1.3.2
- go.etcd.io/bbolt v1.3.4
- go.opencensus.io v0.22.6
- go.uber.org/zap v1.14.1
- golang.org/x/crypto v0.0.0-20220427172511-eb4f295cb31f
- golang.org/x/exp v0.0.0-20210201131500-d352d2db2ceb
- golang.org/x/image v0.0.0-20201208152932-35266b937fa6
- golang.org/x/mobile v0.0.0-20210208171126-f462b3930c8f
- golang.org/x/mod v0.4.2
- golang.org/x/net v0.0.0-20220425223048-2871e0cb64e4
- golang.org/x/oauth2 v0.0.0-20220411215720-9780585627b5
- golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6
- golang.org/x/term v0.0.0-20220411215600-e5f449aeb171
- golang.org/x/time v0.0.0-20201208040808-7e3f01d25324
- google.golang.org/api v0.39.0
- google.golang.org/genproto v0.0.0-20220324131243-acbaeb5b85eb
- google.golang.org/grpc v1.45.0
- google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0
- google.golang.org/grpc/examples v0.0.0-20210210183804-ad24ab52b162
- google.golang.org/grpc=>google.golang.org/grpc v1.34.0
- google.golang.org/protobuf v1.28.0
- gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c
- gopkg.in/ini.v1 v1.62.0
- gopkg.in/osteele/liquid.v1 v1.2.4
- gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
- sigs.k8s.io/yaml v1.2.0
go.sum
go
- 1198 dependencies