ceiba

Web service to manage scientific simulation data

https://github.com/nlesc-nano/ceiba

Keywords

Keywords from Contributors

Repository

Web service to manage scientific simulation data

README.rst

.. image:: https://github.com/nlesc-nano/ceiba/workflows/build/badge.svg
   :target: https://github.com/nlesc-nano/ceiba/actions
.. image:: https://readthedocs.org/projects/ceiba/badge/?version=latest
   :target: https://ceiba.readthedocs.io/en/latest/?badge=latest
.. image:: https://codecov.io/gh/nlesc-nano/ceiba/branch/main/graph/badge.svg?token=MTD70XNYEA
   :target: https://codecov.io/gh/nlesc-nano/ceiba
.. image:: https://zenodo.org/badge/297567281.svg
   :target: https://zenodo.org/badge/latestdoi/297567281

#####
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:

#. 🐳 Install `Docker `_

#. 🚀 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 `_.

Owner

Citation (CITATION.cff)

# YAML 1.2
---
cff-version: 1.2.0
title: "ceiba"
authors:
  -
    family-names: Zapata
    given-names: Felipe
    orcid: "https://orcid.org/0000-0001-8286-677X"
date-released: 2020-10-03
keywords:
  - "quantum-chemistry"
  - "materials-science"
version: "0.1.0"
repository-code: "https://github.com/nlesc-nano/ceiba"
message: "If you use this software, please cite it using these metadata."
license: Apache-2.0

GitHub Events

Committers

Last synced: 10 months ago

Issues and Pull Requests

Last synced: 11 months ago