Giter Site home page Giter Site logo

climada_papers's Introduction

READ ME

This repository contains an overview of the publications and corresponding software components implemented in CLIMADA Python. Please see climada_papers_overview.md for a list of publications and Zenodo DOI links.

How to publish code for a CLIMADA-paper

This file provides an overview of the steps to take when publishing code corresponding to a peer-reviewed CLIMADA article or technical paper. The intended audience is the authors of the given code and paper. Please make sure to follow the steps carefully so the information is correct and your code easily accessible.

  • Create your own GitHub repository to store the code
  • Upload all relevant code
  • Add a readme file with all the information necessary to replicate your analysis, including which CLIMADA version was used
  • Make a Zenodo release
  • Update the paper overview climada_papers_overview.md in the climada_papers repository with the paper DOI and the code DOI from Zenodo (create a new row on top of the existing table)

climada_papers's People

Contributors

carmensteinmann avatar chahank avatar davidnbresch avatar evelyn-m avatar gabrielaznar avatar manniepmkam avatar raphael-portmann avatar sameberenz avatar samluethi avatar sarah-hlsn avatar thomasroosli avatar timschmi95 avatar zeliest avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

climada_papers's Issues

DOI attribution

For scientific publications, it is often required to provide a DOI linking to the used code and/or data. The purpose of this repository is to gather precisely the code of published work that used CLIMADA.

Proposal: make a DOI with Zenodo for the entire repository.

  • Each time a new work is added, a new release is made which is associated with a new DOI
  • There is also a common single DOI for all the releases of the CLIMADA_papers repository

Question: how to set the authorship of the DOI?

  1. Add all the authors of all the papers in the repository?
  2. The person that adds a contribution must specificy who should be listed as author of the code.

Question: what account should manage the Zenodo account?

  1. David?
  2. A group account? with for instance a [email protected]

Issues:

  • The author list might get very large
  • The authorship between papers becomes mixed
  • Single code does not get a single DOI, but the DOI is always for the whole CLIMADA_papers repository.
  • The number of included papers might become very large too if the use of CLIMADA grows quickly and then finding one code in the project folder might become too cumbersome.

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.