The highest tagged major version is v4.

core/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pixlise/core

Links

Open Source Insights

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
api Contains "core"-level helper code to build APIs.	Contains "core"-level helper code to build APIs.
auth0login Contains all the code needed to do an Auth0 login and retrieve a JWT.	Contains all the code needed to do an Auth0 login and retrieve a JWT.
awsutil AWS utility functions to wrap some functionality and provide mocking capabilities for unit testing.	AWS utility functions to wrap some functionality and provide mocking capabilities for unit testing.
cloudwatch Wraps cloudwatch log reading into one simple package	Wraps cloudwatch log reading into one simple package
dataset Contains access/util functions to read parts of binary protobuf dataset files, JSON dataset metadata summaries, spectra, etc	Contains access/util functions to read parts of binary protobuf dataset files, JSON dataset metadata summaries, spectra, etc
detector Reading PIXLISE detector configs	Reading PIXLISE detector configs
downloader Parallel file downloader that knows where to download from based on ids requested	Parallel file downloader that knows where to download from based on ids requested
export Exporter module allowing creation of a zip file containing requested files.	Exporter module allowing creation of a zip file containing requested files.
expressions Data structures used to store expressions (both Lua and PIXLang expression code)	Data structures used to store expressions (both Lua and PIXLang expression code)
database Contains all functionality to access expressions and modules from Mongo DB	Contains all functionality to access expressions and modules from Mongo DB
modules Data structures used to store and version modules (code in Lua environment)	Data structures used to store and version modules (code in Lua environment)
zenodo
zenodo-models
fileaccess Provides a higher-level file access interface which is implemented using local file storage as well as AWS S3.	Provides a higher-level file access interface which is implemented using local file storage as well as AWS S3.
kubernetes Utilities to connect to and command a Kubernetes cluster to start and shut down pods.	Utilities to connect to and command a Kubernetes cluster to start and shut down pods.
logger A common logging interface used throughout the code which has implementations using stdout and AWS cloudwatch.	A common logging interface used throughout the code which has implementations using stdout and AWS cloudwatch.
mongo Lowest-level code to connect to Mongo DB (locally in Docker and remotely) and get consistant collection names.	Lowest-level code to connect to Mongo DB (locally in Docker and remotely) and get consistant collection names.
notifications Interface for all notification capabilities (sending emails to users and the UI)	Interface for all notification capabilities (sending emails to users and the UI)
templates Text templates for various types of notifications including HTML vs simple text versions	Text templates for various types of notifications including HTML vs simple text versions
piquant Storage/versioning and retrieval of PIQUANT configuration files and the currently selected PIQUANT pod version to be run	Storage/versioning and retrieval of PIQUANT configuration files and the currently selected PIQUANT pod version to be run
pixlUser Storage/retrieval of PIXLISE user data and preferences from Mongo DB.	Storage/retrieval of PIXLISE user data and preferences from Mongo DB.
quantModel Exposes interfaces and structures required to run PIQUANT in the Kubernetes cluster along with functions to access quantification files, logs, results and summaries of quant jobs.	Exposes interfaces and structures required to run PIQUANT in the Kubernetes cluster along with functions to access quantification files, logs, results and summaries of quant jobs.
roiModel Exposes structures and functions to store/retrieve/share regions of interest including MIST algorithm versions	Exposes structures and functions to store/retrieve/share regions of interest including MIST algorithm versions
tagModel Exposes structures and functions to store/retrieve/share tags which are applied to various user-created objects to allow easier filtering/tracking of them	Exposes structures and functions to store/retrieve/share tags which are applied to various user-created objects to allow easier filtering/tracking of them
timestamper An interface to get a unix time stamp (in seconds) with an included mock that can be pre-loaded with timestamps for predictable unit test output.	An interface to get a unix time stamp (in seconds) with an included mock that can be pre-loaded with timestamps for predictable unit test output.
utils Exposes various utility functions for strings, generation of valid filenames and random ID strings, zipping files/directories, reading/writing images	Exposes various utility functions for strings, generation of valid filenames and random ID strings, zipping files/directories, reading/writing images