diff --git a/README.md b/README.md index a5a2603a..15585927 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,82 @@ - -[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) - ---- - -# JZFS - -#### 🚧 Current Status: Incubating - JZFS is not ready for production usage. The API is still evolving and documentation is lacking. -JZFS is a version control filesystem based on Git protocol for data management and publication with a command line interface and a Python API. With JZFS, you can version control arbitrarily large data, share or consume data, record your data’s provenance, and work computationally reproducible. - -## Current Status and Roadmap +

+ + + + JZFS Logo + +

+ +

Git Based & Version Control & Joint Management
for code, data, model and their relationship

+ +> Delivers distributed data management system that keeps track of your data from code to PB scale dataset and ensures reproducibility. + +
+

+ JZFS Cloud | + User Guide | + API Docs | + Roadmap 2025 +

+ + +Version + + +Releases + + +Docker Pulls + + +GitHub Actions + + +Codecov + + +License + + +
+ + +Slack + + +Twitter + + +LinkedIn + +
+ +## Introduction + +**JZFS** is an open-source, cloud-native version control filesystem based on Git protocol for data management and publication with a command line interface and a Python API. With JZFS, you can version control arbitrarily large data, share or consume data, record your data’s provenance, and work computationally reproducible. + +JZFS adapts principles of open-source software development and distribution to address the technical challenges of data management, data sharing, and digital provenance collection across the life cycle of digital objects. + +![](docs/jzfs-joint-management.png) + +Compared with code in software development, data tend not to be as precisely +identified because data versioning is rarely or only coarsely practiced. Scientific computation +is not reproducible enough, because data provenance, the information of how a digital file +came to be, is often incomplete and rarely automatically captured. Last but not least, in +the absence of standardized data packages, there is no uniform way to declare actionable +data dependencies and derivative relationships between inputs and outputs of a computation. JZFS aims to solve these issues by providing streamlined, transparent management +of code, data, computing environments, and their relationship. + +### Current Status and Roadmap JZFS is still in the early development stages and is considered **incubating**. There is no commitment to ongoing maintenance or development. As the project evolves, this may change in the future. Therefore, we encourage you to explore, experiment, and contribute to JZFS, but do not attempt to use it in production. The immediate next steps for the project are to fill obvious gaps, such as implementing error handling, removing panics throughout the codebase, supporting additional data types, and writing documentation. After that, development will be based on feedback and contributions. +JZFS's long-term goal is to build data ecosystems that enable new innovations. + + ### Reserach Data Management JZFS is based on Git with extend capabilities, especially with respect to managing large files. @@ -31,7 +92,7 @@ JZFS is used to collect all experimental metadata about the complete timeline of longitudinal and multimodal animal experiments, including MRI, histology, electrophysiology, and behavior. -![](./docs/research-flow.png) +![](./docs/jzfs-research-flow.png) Project planning and experimental details are recorded in an in-house relational cloud-based database. A key element for both the database and the data storage is the @@ -43,16 +104,12 @@ specific project is organized following the YODA principles (https://handbook.da In preparation for publication and to facilitate data reproducibility, the experimental raw and processed data is made publicly available on GitData.AI. - JZFS is used as the central data management tool (Fig. above) and for version control: It keeps track of which files were modified, when, and by whom, and provides the ability to restore previous states. To this end, JZFS is agnostic of the data type and provides a unified interface for managing code and data files. -#### joint management of code, data, and their relationship -![](docs/jzfs-joint.png) - -### Added value +### DataHub Our central use case is the DataHub(Like Github, buf for Data),which essentially consists of a Git version control for data and a Git collaboration for data. In the JZFS DataHub model, each node maintains a copy of the files and all of the history of each file. @@ -63,9 +120,9 @@ Writes are organized on branches. Git is designed to compute differences between versions quickly. Generally, Git relies on human action to share and merge changes. -Fault tolerance and trustless-ness are achieved via the separation of remotes from individual nodes. -Each node in the network is maintaining it's own copy, its history and coordinating via one or many remotes. -If a remote you trust gets corrupted, you have the ability to roll back to a previous good state and switch to a new remote. +Fault tolerance and trustless-ness are achieved via the separation of remotes from individual nodes. +Each node in the network is maintaining it's own copy, its history and coordinating via one or many remotes. +If a remote you trust gets corrupted, you have the ability to roll back to a previous good state and switch to a new remote. Even if you lose your copy you can rely on other nodes' copies to restore from. This enables us to create transparency across internal and external data. @@ -74,6 +131,7 @@ It forms the basis for a new way of practicing data exchange and contract design It is crucial that data exchange works both within the company and in individually controllable data networks (data space). +### Data Space JZFS data space consists of so-called “DataHubs” like one or many remotes in Git, which are virtual data nodes for sharing data and building data networks. A single DataHub manages various data connections and can join together with other hubs to form a network through targeted synchronization. Based on data contracts mapped in the network, data can be released to other participants, enabling efficient data exchange. @@ -81,11 +139,14 @@ Based on data contracts mapped in the network, data can be released to other par ![](./docs/jzfs-space.png) -JZFS offers git for data technology for exchanging data in data hub and data space. +JZFS offers git for data technology for exchanging data in data hub and data space. + The added value is clear: simple, transparent data management combined with intuitive linking and sharing of data in decentralized networks – data space. This enables secure, trustworthy data exchange across organizational boundaries. -JZFS's long-term goal is to build data ecosystems that enable new innovations. + + + ### Deploy ```bash diff --git a/docs/jzfs-joint-management.png b/docs/jzfs-joint-management.png new file mode 100644 index 00000000..32d77f9e Binary files /dev/null and b/docs/jzfs-joint-management.png differ diff --git a/docs/jzfs-logo-words.png b/docs/jzfs-logo-words.png new file mode 100644 index 00000000..baf3e630 Binary files /dev/null and b/docs/jzfs-logo-words.png differ diff --git a/docs/jzfs-logo.png b/docs/jzfs-logo.png new file mode 100644 index 00000000..5fe2dc15 Binary files /dev/null and b/docs/jzfs-logo.png differ diff --git a/docs/jzfs-research-flow.png b/docs/jzfs-research-flow.png new file mode 100644 index 00000000..ced31224 Binary files /dev/null and b/docs/jzfs-research-flow.png differ