Skip to content

nlesc-nano/ceiba

Repository files navigation

https://readthedocs.org/projects/ceiba/badge/?version=latest https://codecov.io/gh/nlesc-nano/ceiba/branch/main/graph/badge.svg?token=MTD70XNYEA

ceiba

🧬 🔭 🔬 Scientific simulations generate large volume of data that needs to be stored and processed by multidisciplinary teams across different geographical locations. Distributing computational expensive simulations among the available resources, avoiding duplication and keeping the data safe are challenges that scientists face every day.

Ceiba and its command line interface Ceiba-cli solve the problem of computing, storing and securely sharing computationally expensive simulation results. Researchers can save significant time and resources by easily computing new data and reusing existing simulation data to answer their questions.

See documentation and blog post.

Installation

The provisioning folder contains the instructions to deploy the web service using docker. Alternatively, you can deploy the web service locally using the following instructions:

  1. 🐳 Install Docker

  2. 🚀 Define a environment variable MONGO_PASSWORD with the database password. Now you can run the following command to start both the server and the mongodb services:

    provisioning/start_app.sh
    

Contributing

If you want to contribute to the development of ceiba, have a look at the contribution guidelines.

License

Copyright (c) 2020-2021, Netherlands eScience Center

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Credits

This package was created with Cookiecutter and the NLeSC/python-template.