-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
README wording #1
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,76 +1,73 @@ | ||
# [copernic](https://github.com/amirouche/copernic): awesome data store | ||
# [foundation](https://github.com/amirouche/foundation) | ||
|
||
**alpha** | ||
|
||
![data](https://raw.githubusercontent.com/amirouche/copernic/master/data.jpg) | ||
![data](https://github.com/amirouche/foundation/raw/main/data.jpg) | ||
|
||
## Abstract | ||
|
||
copernic is web application that is (mostly) implemented with Python | ||
programming language. It is supported by a database that is a triple | ||
store versioned. It is possible to do time traveling queries at any | ||
point in history while still being efficient to query and modify the | ||
latest version. The versioned triple store is implemented using a novel | ||
approach dubbed generic tuple store. copernic goal is to demonstrate | ||
that versioned databases allow to implement workflows that ease | ||
cooperation. | ||
foundation is a programming system (mostly) implemented with seeds, by seeds. | ||
|
||
## Keywords | ||
It is supported by a data store that keeps track of everything that | ||
can be understood. It is possible to time travel at any point in | ||
History, and through any story. Meanwhile it is still efficient to | ||
query | ||
Comment on lines
+13
to
+14
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There are several ways to represent "branches", or "theories" and infer from them. Foundation stores the changes, results come later, and then are stored. |
||
and modify the present. | ||
|
||
- data management system | ||
- data science | ||
- knowledge base | ||
- open data | ||
- python programming language | ||
- quality assurance | ||
- reproducible science | ||
- version control system | ||
The data, and its history is stored in Foundation. | ||
|
||
## Introduction | ||
foundation demonstrate that versioned knowledge allow to implement workflows | ||
that ease cooperation. | ||
Comment on lines
+19
to
+20
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/foundation demonstrate that versioned knowledge allows to implement workflows that ease cooperation./foundation demonstrate that versioned knowledge helps practice of cooperation./ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ? |
||
|
||
## De suite | ||
|
||
Follow the hip cli hop dance: | ||
|
||
```sh | ||
python3 -m venv venv | ||
source venv/bin/activate | ||
pip install -r requirements.txt | ||
./manage.sh migrate | ||
./manage.sh createsuperuser | ||
./manage.sh runserver | ||
``` | ||
|
||
## Foundation | ||
|
||
Versioning in production systems is a trick everybody knows about | ||
whether it is through backup, logging systems and ad-hoc [audit | ||
trails](https://code.djangoproject.com/wiki/AuditTrail). It allows to | ||
inspect, debug and in worst cases rollback to previous states. There | ||
is not need to explain the great importance of versioning in software | ||
management as tools like git, mercurial, and fossil have shaped modern | ||
computing. | ||
|
||
Having the power of versioning open the door to manyfold applications. | ||
Like, it allows to implement a mechanic similar to github's pull | ||
requests and gitlab's merge requests in many products. That very | ||
mechanic is explicit about the actual human workflow in entreprise | ||
settings, in particular, when a person validates a change made by | ||
another person. | ||
|
||
The *versioned triple store* make the implementation of such mechanics | ||
more systematic and less error prone as the implementation can be | ||
shared across various tools and organisations. | ||
|
||
copernic takes the path of versioning data and apply the | ||
change-request mechanic to collaborate around the making of a | ||
knowledge base, similar in spirit to | ||
[WikiData](https://wikidata.org/) and inspired from existing data | ||
management systems like CKAN. | ||
|
||
The use of a version control system to store [open | ||
data](https://en.wikipedia.org/wiki/Open_data) is a good thing as it | ||
draws a clear path for reproducible science. But none, meets all the | ||
expectations. **copernic aims to replace the use of git and make | ||
practical cooperation around the creation, publication, storage, | ||
re-use and maintenance of knowledge bases that are possibly bigger | ||
than memory.** Resource Description Framework (RDF) offers a good | ||
canvas for cooperation around open data but there is no solution that | ||
is good enough according to [Collaborative Open Data versioning: a | ||
pragmatic approach using Linked Data, by Canova *et | ||
al.*](https://core.ac.uk/download/pdf/76527782.pdf) | ||
|
||
copernic use a novel approach to store triples in an [ordered key-value | ||
store](https://en.wikipedia.org/wiki/Ordered_Key-Value_Store). It use | ||
[FoundationDB database storage engine](https://www.foundationdb.org/) | ||
to deliver a pragmatic versatile ACID-compliant versioned triple store | ||
where people can cooperate around the making of knowledge. copernic | ||
only stores changes between versions. It has also a snapshot of the | ||
latest version. copernic does not rely on the theory of patches | ||
introduced by Darcs but re-use some its vocabulary. copernic is the | ||
future. | ||
whether it is through backup, doublpe, and triple backups, logging | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/doublpe/double/ |
||
systems, bank and ad-hoc audit trail, in other words tracebility wins | ||
(wait for the debbuger (read how to debug programs by Dybvig!)!). | ||
|
||
It allows to inspect, debug and in worst cases rollback to previous | ||
states. There is no need to explain the great importance of history in | ||
software enginerring as tools like fossil have shaped the | ||
anthroposcene. | ||
|
||
Having the power of History kicks the beats of manyfolds. | ||
|
||
Like, it allows to implement a mechanic similar to pull | ||
requests and change requests in many products. That very | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. to pull, to change, and to request for merge. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/products/code spaces/? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/of manyfolds/to manyfolds/ |
||
mechanic is explicit about actual people, in particular, | ||
when we reply, and cheers a change made by another. | ||
|
||
*versioned structured knowledge* make the implementation of such | ||
mechanics more systematic and less error prone as the implementation | ||
can be shared across various tools and communities. | ||
|
||
foundation takes the path of versioning data (or things, or ghosts, | ||
(or people)) and apply the change-request mechanic to collaborate | ||
around our making. | ||
|
||
**foundation aims to make practical cooperation around the creation, | ||
publication, storage, re-use and sustainability of knowledge that is | ||
bigger than any known human memory.** | ||
|
||
**Tech**: Foundation is stored in | ||
[FoundationDB](https://www.foundationdb.org/) to deliver, with opt-in, | ||
a pragmatic versatile ACID-compliant versioned triple store, where | ||
people can cooperate around the making of knowledge. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ~s/.*/cooperate around our making/ |
||
|
||
-- | ||
|
||
a Foundation engineer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(It is not exactly fubu)