https://github.com/scientificcomputing/example-paper
Example of paper with code
https://github.com/scientificcomputing/example-paper
Last synced: 2 months ago
JSON representation
Example of paper with code
- Host: GitHub
- URL: https://github.com/scientificcomputing/example-paper
- Owner: scientificcomputing
- License: mit
- Created: 2022-11-10T13:06:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-04-21T06:07:50.000Z (3 months ago)
- Last Synced: 2026-04-21T08:16:16.890Z (3 months ago)
- Language: Python
- Homepage: https://scientificcomputing.github.io/example-paper/
- Size: 415 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Supplementary code for the paper: Title of paper
[](https://mybinder.org/v2/gh/scientificcomputing/example-paper/HEAD)
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
First install `uv`
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```
Then create a virtual environment and install dependencies
```bash
uv venv
source .venv/bin/activate
uv sync --locked --all-extras --dev
```
We also 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](https://docs.docker.com/get-docker/).
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