This repository contains the documentation for the Computational Research Environment Standardization Protocol (CRESP), an open standard designed to ensure reproducibility in computational research across various disciplines.
CRESP is part of the Rescience Lab product by Wisup AI Ltd. The protocol is designed to support researchers in computational science and cross-disciplinary fields, including bioinformatics, medical informatics, geoinformatics, quantitative finance, computational physics, computational chemistry, and more.
Our goal is to address the challenges faced by researchers who use computational methods but may lack strong programming backgrounds. By standardizing computational environments, CRESP helps researchers focus on their domain expertise rather than struggling with technical configuration issues.
CRESP is open source and released under the MIT License. This permissive license allows for maximum flexibility in using, modifying, and distributing the protocol.
Visit our documentation at: https://cresp.resciencelab.ai
This documentation website is built using Docusaurus, a modern static website generator.
- English (default)
- Chinese (Simplified)
For information on how to contribute to translations, please see TRANSLATION.md.
$ yarn
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
We welcome contributions to the CRESP documentation! Please see our Contributing Guidelines for more information on how to get involved.
This project follows Semantic Versioning. For the versions available, see the tags on this repository.
All notable changes to this project are documented in the CHANGELOG.
This documentation is licensed under the MIT License. See the LICENSE file for details.