Git Product home page Git Product logo

fgputil's Introduction

FgpUtil

Description

Contains a set of utility scripts and software libraries shared across the VEuPathDB project and available for general use. These include:

  • fgpJava: a convenient way to run a Java class (containing a main method) while auto-configuring the classpath to use all JARs in $GUS_HOME/lib/java
  • conifer: a software configuration system based on J2 templates and YAML config vars
  • validateXmlWithRng: a way to validate a set of XML documents using a RelaxNG schema

A build produces a set of Java artifacts (JARs), each addressing a utility category. They are:

  • Core: a wide assortment of utility classes providing functionality not addressed in the categories below
  • AccountDB: access and configuration of user accounts stored in an AccountDB schema
  • Cache: in-memory cache system
  • Cli: command line utilities
  • Client: HTTP client utilities
  • Db: database configuration, vendor-specific code, connection pooling
  • Events: asynchronous event triggering and subscription
  • Json: utilities for reading, validating, typing, and serializing JSON
  • Server: extensible Grizzly-based HTTP server implementing JAX-RS
  • Web: vendor-neutral HTTP utility classes and interfaces
  • Servlet: Servlet-based implementations of the interfaces in Web
  • Solr: SOLR response parsing
  • Test: support for unit tests
  • Xml: XML parsing and validation

FgpUtil also contains a Dependencies directory containing not-generally-available Java libraries in a Maven repository structure. They can thus be referenced by our pom.xml files as dependencies without including JARs directly in our project repositories.

Build and Dependencies

Java

FgpUtil's Java code requires Java 11 or higher and can be built by Maven 3+ directly or as part of the GUS build system (also requiring Maven 3+). A comprehensive list of its JAR dependencies (and any additional repositories) can be found in the component pom.xml files.

Scripts

Nearly all scripts in FgpUtil are written in bash or perl, and many are wrappers around Java code. The perl code in FgpUtil expects Perl 5.x. To access the scripts, one would typically build FgpUtil using the GUS build system and add $GUS_HOME/bin to their $PATH.

fgputil's People

Contributors

ryanrdoherty avatar steve-fischer-200 avatar mheiges avatar dmfalke avatar foxcapades avatar jbrestel avatar jtlong3rd avatar rbelnap avatar aurreco-uga avatar fossilfriend avatar

Watchers

James Cloos avatar

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.