-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8c45eaf
commit 147c465
Showing
1 changed file
with
17 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,24 @@ | ||
Working in Alpha | ||
|
||
# Overview | ||
|
||
ro-crate-rs is a rust library, python library and CLI tool for interfacing with Reserach Object Crates. It's aim is to provide a robust, portable and scalable solution to dealing RO-Crates within the varying software environments that are present across a Synthetic Biology Laboratory stack. It enforces minimal RO-Crate structure adherence through it's defined data types, but equally allows the crate to be as expansive as needed. | ||
ro-crate-rs is a rust library, python library and CLI tool for interfacing with Reserach Object Crates. | ||
It's aim is to provide a robust, portable and scalable solution to dealing | ||
RO-Crates within the varying software environments that are present across a Synthetic Biology | ||
Laboratory stack. It enforces minimal RO-Crate structure adherence through it's | ||
defined data types, but equally allows the crate to be as expansive as needed. | ||
|
||
The CLI tool can be used to immediately interface with RO-Crates within a somewhat constrained and structured environment, however an understanding of RO-Crate is a realistic requirement to conform with schema.org specifications. | ||
The CLI tool can be used to immediately interface with RO-Crates within a somewhat | ||
constrained and structured environment, however an understanding of RO-Crate | ||
is a realistic requirement to conform with schema.org specifications. | ||
|
||
The python library (pycrate) allows the primary rust library to be leveraged in python. It's designed to be maximally flexible with minimal onboarding, allowing you to incorprate it into scrpits/ data pipelines as easily as possible. This also relies on you to have an understanding of the structure of an RO-Crate, but focuses more on the fact that some metadata is better than no metadata. | ||
The python library (pycrate) allows the primary rust library to be leveraged in python. | ||
It's designed to be maximally flexible with minimal onboarding, allowing you to | ||
incorprate it into scrpits/ data pipelines as easily as possible. This also | ||
relies on you to have an understanding of the structure of an RO-Crate, but | ||
focuses more on the fact that some metadata is better than no metadata. | ||
|
||
# Compatability | ||
|
||
RO-Crate v1.1 | ||
|