Code Monkey home page Code Monkey logo

cobald-hep-plugins's Introduction

COBalD/TARDIS Plugins for High Energy Physics

Documentation Status

This package collects official and third-party plugins for the COBalD / TARDIS resource manager.

How do I use these plugins?

The plugins work like the basic COBalD/TARDIS components: install the package and the plugins are automatically available in configuration and code.

The package is directly available via pip and must be installed to the same python3 environment as COBalD/TARDIS.

$ python3 -m pip install cobald-hep-plugins

Consult the documentation on how to use individual plugins.

Do I have to publish plugins here?

You are free to publish and maintain plugins yourself. All COBalD/TARDIS plugins are just regular Python packages which set some specific metadata.

Plugins in this repository are reviewed by the COBalD/TARDIS team and maintained with similar standards as the core frameworks.

How do I publish a plugin here?

Before proposing a plugin, please reach out to us for advise. This could be for example via email, chats, or just opening a ticket.

To add a new plugin, head to our GitHub repository and open a pull request that adds your plugin. Plugins are modules or sub-packages in the cobald_hep_plugins folder that can also come with additional meta-data. See the cobald_hep_plugins/example as a template.

In addition to the plugin itself, you should provide

  • unittests in a tests subfolder, and
  • documentation in a docs/plugins file or subfolder.

cobald-hep-plugins's People

Contributors

maxfischer2781 avatar dirksammel avatar

Stargazers

 avatar  avatar Manuel Giffels avatar

Watchers

Stefan Kroboth avatar James Cloos avatar Manuel Giffels avatar Benjamin Rottler avatar  avatar Eileen Kuehn avatar

Forkers

dirksammel

cobald-hep-plugins's Issues

Document version policy

The version currently mimics the COBalD version. For example, version 0.12.X is compatible with COBalD 0.12.X.

This should be documented in the maintenance section of our documentation.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.