GithubHelp home page GithubHelp logo

o2r-project / architecture Goto Github PK

View Code? Open in Web Editor NEW
10.0 9.0 4.0 8 MB

Architecture and overarching documentation for o2r microservices

Home Page: https://o2r.info/architecture/

License: Creative Commons Zero v1.0 Universal

Makefile 100.00%
erc reproducible-research reproducible-science reproducible-experiments

architecture's Introduction

Opening Reproducible Research System Architecture

Project website: https://o2r.info

Read architecture description online: https://o2r.info/architecture

The project

Opening Reproducible Research (o2r) is a DFG-funded research project by Institute for Geoinformatics (ifgi) and University and Regional Library (ULB), University of Münster, Germany. Building on recent advances in mainstream IT, o2r envisions a new architecture for storing, executing and interacting with the original analysis environment alongside the corresponding research data and manuscript. This architecture evolves around so called Executable Research Compendia (ERC) as the container for both research, review, and archival.

Guidelines

See CONTRIBUTING.md

Build

This specification is written in Markdown, rendered with MkDocs using a few Python Markdown extensions, and deployed automatically using a Github Action.

badge for workflow status

Use mkdocs to render it locally.

# pip install mkdocs mkdocs-cinder
mkdocs serve

Automated Builds

The deploy_site.yml will run the mkdocs command on every direct commit or merge on the master branch and deploy the rendered HTML documents to the gh-pages branch in this repository.

The action authenticates its push to the gh-pages branch using the checkout action and the credentials of the user @o2r-user, who has write access to this repository. It is finalized through the github pages deploy action.

Diagrams

The diagrams are created with yEd. All source files (.graphml) are stored in /docs/img. The PNG renderings are exported from yEd with transparent background, a margin of 5, and a scaling factor of 1.0.

License

The o2r Executable Research Compendium specification is licensed under Creative Commons CC0 1.0 Universal License, see file LICENSE. To the extent possible under law, the people who associated CC0 with this work have waived all copyright and related or neighboring rights to this work. This work is published from: Germany.

architecture's People

Contributors

fmazin avatar nuest avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

architecture's Issues

Integrate ERCs into life-cycle of scholarly objects and scholarly identifiers

Identifiers, PIDs for objects

Person, Institutionen PIDs

Research information systems

Others

Add further information on interaction and manipulation of ERC

[this came out of discussion with publisher senior architect]

The usage of Shiny for interactive papers is not described in the architecture at all.

  • add a new box "ERC manipulation" to section 5.2.7
  • add a description of the box in refinement level 3 (is this the o2r-substituter or the o2r-manipulater??)

Clarify role of ID provider in business context

[this came out of discussion with publisher senior architect]

Update business context to clarify role of ID provider. Right now there is a mix-up between authentication vs. authorization and between envisioned architecture vs. technical details of the reference implementation.

Tasks

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.