diff --git a/CODEMETA.json b/CODEMETA.json index 5a4327a..fcc1459 100644 --- a/CODEMETA.json +++ b/CODEMETA.json @@ -1,24 +1,24 @@ { "@context": "https://doi.org/10.5063/SCHEMA/CODEMETA-1.0", "@type": "Code", "author": [ { "@type": "Person", "name": "Antoine Masson", "@id": "https://orcid.org/0000-0002-7993-5698", "affiliation": "Ecole Polytechnique Fédérale de Lausanne, Library", "email": "antoine.masson@epfl.ch" - } + }, ], "name": "Cost Calculator", "softwareVersion": "beta 2.1", "identifier": "10.5281/zenodo.1469035", "datePublished": "2018-10-08", "codeRepository": "https://c4science.ch/source/costcalc/repository/master/", - "URL": "https://rdmepfl.github.io/costcalc/", + "URL": "https://costcalc.epfl.ch", "programmingLanguage": "javascript", "keywords": "research data, storage, cost estimate, planning", "description": "A dynamic online tool for calculating the cost of research data storage services. It's highly modular and can be adapted for all kind of application. The system is really easy to install as it uses only opensource javascript libraries.", "license": "GPL-3.0-only" } diff --git a/README.md b/README.md index 3938cbf..b10b9de 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,43 @@ Cost Calculator ============ -(https://rdmepfl.github.io/costcalc/) +(https://costcalc.epfl.ch) ## Introduction The cost calculator is an online project for calculating the cost of services. It's originally designed for helping researcher for estimating the cost of managing data. The user can calculate the cost of the data life cycle directly from the interface. Categories, Providers, Cost can be easily updated by just changing the **data.js** so it can be adapted for your own institution. ## How to use it The structure is highly modular and can be extended for different projects. All the information are stored on javascript and the system only uses javascript libraries making really easy to install and update. You don't need a specific webserver (but you can use one), just use your github repo and create a pages link your cost calculator will be accessible ## Documentation The documentation of the project explains how to install it and configure it. See [Docs](./Docs) ## Files/Folders * All the engine is stored in the **js** folder * index.html : main index for production * **docs** contains the documentation for changing the database of provider or the engine itself. * __index-dev.html__ : Index file for development only * __index-pres.html__ : Index file for presentation only ## Citation The project is hosted on Zenodo : [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1469034.svg)](https://doi.org/10.5281/zenodo.1469034) The citation information are in the __CITATION__ file and __CODEMETA.json__. ## License and Term of Usage This project is release under GNuv3 license see __LICENSE__. It's a work of the Research Data Management Team at EPFL Library in Switzerland. diff --git a/docs/README.md b/docs/README.md index 768ccb2..c184b03 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,37 +1,24 @@ Cost Calculator Documentation ============ # Introduction -(https://rdmepfl.github.io/costcalc/) +(https://costcalc.epfl.ch) This documentation presents how to configure the cost calculator, it's not dedicated for final users but more for people that wants to update or change providers or to develop new tools inside the cost calculator. If you want to add/update a category or a provider you want to change **data.js** The corresponding doc is here [data.js-config](data.js-config.md) If you want to change something in the engine (or something not possible from **data.js**) See [configure.md](configure.md) # INSTALL You can use the cost calculator on your own webserver or use github pages. If you use github pages you just need your own github repository and your cost calculator will be hosted by github (Use full if your IT service does'nt want you to have your own web space) ## Use your own webserver It's pretty easy just copy the latest release into your a directory accessible from your webserver and it will work. To personalize the tool See [configure.md](configure.md). - - -## Use GitHub pages -You can import the repository (using the plus button) - -**Don't use fork** as it's designed if you want to help us to improve the tool. - -Then clone it to your computer. - -To personalize the tool See [configure.md](configure.md). - -By activating GitHub pages from the **settings** of your repository you get an .io url that will publish your tool. -