Data

Tools

Indexes

Applications

Experiments

Open Source Science

example-paper

Example of paper with code

https://github.com/scientificcomputing/example-paper

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Example of paper with code

Basic Info
Statistics
  • Stars: 3
  • Watchers: 3
  • Forks: 1
  • Open Issues: 0
  • Releases: 1
Created over 3 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

Supplementary code for the paper: Title of paper

Binder

This repository contains supplementary code for the paper

Finsberg, H., Dokken, J. 2022. Title of paper, Journal of ..., volume, page, url

Abstract

Provide the abstract of the paper

Getting started

We provide a pre-build Docker image which can be used to run the the code in this repository. First thing you need to do is to ensure that you have docker installed.

To start an interactive docker container you can execute the following command

bash docker run --rm -it ghcr.io/scientificcomputing/example-paper:latest

Pre-processing

Add steps for pre-processing, e.g

cd code python3 pre-processing.py

Running simulation

Add steps for running simulations, e.g

cd code python3 run_all.py

Postprocessing

Add steps for postprocessing / reproducing figures and tables in the paper, e.g

cd code python3 postprocess.py

Citation

@software{Lisa_My_Research_Software_2017, author = {Lisa, Mona and Bot, Hew}, doi = {10.5281/zenodo.1234}, month = {12}, title = {{My Research Software}}, url = {https://github.com/scientificcomputing/example-paper}, version = {2.0.4}, year = {2017} }

Having issues

If you have any troubles please file and issue in the GitHub repository.

License

MIT

Owner

  • Name: Scientific Computing at Simula Research Laboratory
  • Login: scientificcomputing
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
  given-names: "Mona"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
  given-names: "Hew"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 1.2.0
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/scientificcomputing/example-paper"

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Dependencies

.github/workflows/build_docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/docker-image.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action v4 composite
  • docker/login-action v2 composite
  • docker/metadata-action v4 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
docker/Dockerfile docker
  • ubuntu 22.04 build
requirements-dev.txt pypi
  • pdbpp * development
  • pre-commit * development
requirements-docs.txt pypi
  • jupyter-book *
  • jupytext *
  • sphinxcontrib-bibtex *
.github/workflows/pre-commit.yml actions
  • actions/checkout v4 composite
.github/workflows/reproduce_results.yml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
pyproject.toml pypi
  • ap_features *
  • matplotlib *
  • numpy *
  • pandas [output-formatting]
  • scipy *
requirements.txt pypi
  • ap-features ==2023.7.4
  • contourpy ==1.2.0
  • cycler ==0.12.1
  • fonttools ==4.44.0
  • jinja2 ==3.1.2
  • kiwisolver ==1.4.5
  • llvmlite ==0.40.1
  • markupsafe ==2.1.3
  • matplotlib ==3.8.1
  • numba ==0.57.1
  • numpy ==1.24.4
  • packaging ==23.2
  • pandas ==2.1.2
  • pillow ==10.1.0
  • pyparsing ==3.1.1
  • python-dateutil ==2.8.2
  • pytz ==2023.3.post1
  • scipy ==1.11.3
  • six ==1.16.0
  • tabulate ==0.9.0
  • tqdm ==4.66.1
  • tzdata ==2023.3
.github/workflows/deploy_docs.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v3 composite
  • actions/deploy-pages v2 composite
  • actions/download-artifact v3 composite
  • actions/upload-pages-artifact v2 composite